🗂️Upload ID Document File

Upload the respective ID document file type in support of the ID validation process. The ID Document will be validated against the Customer details on record.

Please note that then uploading an ID document file for an ID document type id_card or drivers_license, the front as well as the back of the ID document file is required.

Upload ID document file

POST {{baseUrl}}/identity-documents/:identity_id/upload-document

Upload a file of the ID document (id_book, id_card or drivers_licence).

Path Parameters

Name	Type	Description
identityDocumentId*	String	This the UUID that gets generated in the response of POST Create new identity.

Request Body

Name	Type	Description
back*	File	The file with the image of the back of the ID document needs to be uploaded here (for id_card and drivers_licence)
front*	File	The file with the image of the front of the id document needs to be uploaded here. This applies to all ID documents (for id_card and drivers_licence, the user should upload the file containing the image of the front side of the document; whereas for the id_book, they should upload the front page that contains their ID number, barcode and ID photo).

200: OK Upload Successful

```json
{
    "data": {
        "id": "bb5dc0d3-8fa3-4856-a477-85d2eef75b70",
        "type": "id_card",
        "front": {
            "id": 28,
            "name": "Mike_IDCard_Front.jpeg",
            "type": "jpg",
            "url": "https://dev.apply.fincheck.co.za/gathr-docs/documents/Mike_IDCard_Front.jpeg"
        },
        "back": {
            "id": 29,
            "name": "MIke_ID_Card_Back.jpeg",
            "type": "jpg",
            "url": "https://dev.apply.fincheck.co.za/gathr-docs/documents/MIke_ID_Card_Back.jpeg"
        },
        "valid": false
    }
}
```

404: Not Found No/Invalid Identity ID

```postman_json
{
    "errors": {
        "code": "entity_not_found",
        "message": "Record not found in module_identity_documents"
    }
}
```

422: Unprocessable Entity No ID Documents Uploaded

```postman_json
{
    "errors": {
        "front": [
            "The front field is required."
        ],
        "back": [
            "The back field is required."
        ]
    }
}
```

422: Unprocessable Entity Invalid FIle Format

```postman_json
{
    "errors": {
        "front": [
            "The front must be a file of type: jpg, png, pdf."
        ]
    }
}
```

Uploading files for ID document type - ID Card

Below you can see an example of uploading an ID document file for the ID document type id_card. As you can see, you will need to upload one file for the front of the ID card as well as a file for the back of the ID card.

Upload ID document file back and front (for ID card)

List of Accepted ID documents:

Document	Sides Required	Images
Green RSA ID Book	Front page only
RSA ID Smart Card	Front and Back
Driver's Licence	Front and Back