W2 DocsUpload Document
This section is for consuming the W2 Data IDV Check 013 service.
If using W2-DATA-DOCUMENT_CHECK-039 please refer to Document verification.
How to use
To call the endpoint you will need to perform a HTTP POST request to the URL:
| Url | API Version |
|---|---|
| https://api.w2globaldata.com/documentupload | 1.0+ |
Content Type
The document upload endpoint expects the body of requests to be in the form-data format.
Request
These are the properties this endpoint accepts:
| Property | Mandatory | Details |
|---|---|---|
| ServiceAuthorisation | 🔒 | Contains authorisation information to identify the person using the service. |
| Reference | - | Contains a client-specified tracking reference. Maximum 100 Characters |
| Type | 🔒 | None - No type specified / known. JPEG - A JPEG (Joint Picture Experts Group Image). PNG - A PNG (Portable Network Graphics) image. PDF - A PDF (Portable Document Format). |
| Document | 🔒 | Base64 Encoded representation of the document to upload. |
| Expiry | - | Desired expiry date to apply to the document to upload. If left blank, W2 will use the default value of 14 days to expire the document. This can be set anywhere up to a maximum of 6 months. Once the expiration date has been reached, W2 will remove the image data from our system, however the footprint of the upload will be preserved. |
| QueryOptions | - | Specify optional flags that alter the invocation of the service. See here |
WARNING
Document Size Limit
The maximum file size that we accept for a document upload is 15MB, please ensure your documents are no larger than this before uploading.
Response
Upload Document Response example:
json
{
"bytesUploaded": 108920,
"reference": "123",
"documentTypeValidationSucceeded": true,
"id": "0e397a02-4b7c-5494-abf0-14e2230be606",
"resolvedDocumentType": "JPEG"
}Response breakdown
| Property Name | Description |
|---|---|
| BytesUploaded | The number of bytes uploaded to check against expected number. |
| Reference | An echo of the value that was used on submission - useful when operating asynchronously. |
| DocumentTypeValidationSucceeded | Whether or not the resolved document type matched the type specified by the user (e.g if the user specified the document was a PNG, and the document resolved to a PNG, this value is true). |
| Id | The system assigned unique Id applied to this document on upload. Used to refer to the document when associating documents with a service as a part of the Files element of a KYC Check request. |
| ResolvedDocumentType | The document type as resolved by the service - this can be compared against the expected (submitted) type for validation purposes. - None - No type specified / known. - JPEG - A JPEG (Joint Picture Experts Group Image). - PNG - A PNG (Portable Network Graphics) image. - PDF - A PDF (Portable Document Format) |