KYC Match

PUT https://connect.cabital.com/api/v1/accounts/{account_id}/match

User Account Status¶

Linked
KYC Pass

Request Path Parameters¶

Parameter	Required	Description
`account_id`	Yes	Customer account ID provided by Cabital.

Request Body Parameters¶

Content Type: application/json

Parameter	Required	Type	Description
`id_document`	Yes	string	ID document type, only support following types: `ID_CARD`: ID card `PASSPORT`: Passport
`issued_by`	Yes	string	ID document issuing three-letter country code ISO 3166-1
`id`	Yes	string	ID number
`dob`	Yes	string	Date of birth, format: `YYYY-MM-DD`.
`name`	Yes	string	Customer's full name, in the order of the name on ID document. e.g. `First Name` `Last Name`: John Doe `First Name` `Middle Name` `Last Name`: John Michael Doe

Response Parameters¶

Parameter	Type	Description
`result`	string	The result of KYC match. `PENDING`: Can't match the KYC automatically, need to wait for Cabital to match manually. `PASS`: Match the KYC successfully. `MISMATCH`: Match the KYC failed.
`mismatch_fields`	array[string]	The mismatched fields.

Example¶

Request Data¶

curl -X PUT "http://connect.cabital.com/api/v1/accounts/cdaa9983-9b8f-4478-ba60-896ac239879d/match" \
  -d '{ 
            "name": "John Doe",
            "id": "J12345678D",
            "id_document": "PASSPORT",
            "dob": "19700101",
            "issued_by": "HKG"
      }'

Response Data¶

{
  "result": "MISMATCH",
  "mismatch_fields": [
    "name",
    "dob"
  ]
}