onboard/v1/customer/idScans
[POST] /onboard/v1/customer/idScans
Provide customer ID Scans
For onboarding of customers whose status is returned as ID_SCAN
, this step is required to open the account to an ENABLED
status. This is required for a subset of customers as part of their KYC checks. For more information on statuses, see [GET] Customer Status
The idScans endpoint allows for this required second form of identification (government ID) to be uploaded.
Example [POST]Request
{{avenu_base_url}}/onboard/v1/customer/idScans
{
"newCustomerTag": "",
"image": "",
"imageBack": "",
"idType": "",
}
Input Parameters
Parameter | Format | Required |
---|---|---|
"newCustomerTag" | Valid new customer tag retrieved when onboarding a new customer. | Y |
"image" | The image should be encoded to meet RFC 2045 Base64 requirements. | Y |
"imageBack" | The image should be encoded to meet RFC 2045 Base64 requirements. | N |
"idType" | String | Y |
idType(s)
idType | Description |
---|---|
DRIVER_LICENSE | Drivers License; Requires ID front and back scans |
ID_CARD | Government ID card; Requires ID front and back scans |
PASSPORT | Passport; Requires Passport first page scan |
Example Response
{
"idFront": "", // MD5 hash of the Avenu customer's ID front image
"idBack": "", // MD5 hash of the Avenu customer's ID back image
"idType": "",
}
Updated about 1 month ago