โž•Create New Identity

In order to validate a Customer's ID Document, you will first need to create an Identity for a Customer before performing the ID Document validation.

Please note that we will perform the Validation on the ID Document against the customer details provided in the POST Create New Customer endpoint.

Create New Identity

POST {{baseUrl}}/identity-documents

In order to validate an Identity a unique ID Document identifier needs to be created. The ID Document identifier will contain details of the Customers identity.

Request Body

NameTypeDescription

type*

String

The type of Identity Document you would like to upload to complete the ID Validation against. We support 3 types of South African ID Documents (id_book, id_card and drivers_licence).

customer_Id*

String

This is UUID for a specific customer that gets generated and returned in the POST Create New Customer response. It ensures that the Bank Account is created and can be looked up in future for that specific customer.

```json
{
    "data": {
        "id": "bb5dc0d3-8fa3-4856-a477-85d2eef75b70",
        "type": "id_card",
        "front": null,
        "back": null,
        "valid": false
    }
}
```

Last updated