Get link to upload POI

POST/customers/poi

Generate a unique upload URL for each customer provided in the payload. Utilize the resulting URL(s) to submit their proof of identity documents to Triple-A.

Document supported types: Passport, Driving License, ID Card

Document supported format: JPG, JPEG, PNG, PDF

After uploading the proof of identity document, you will receive a verification result notification via a webhook at the notify_url you specified. More information can be found here.

Sample webhook:

{
    "customer_id": <customer_id>,
    "poi": {
        "id": <poi.id>,
        "status": "accepted" | "declined" | "invalid",
        "declined_reason": <null | reason to decline>
    }
}

The list of declined reasons can be found here.

Body application/json

filesobject[]required
Show files properties
customer_idstringrequired
optionsobject
Show options properties
filenamestringrequired
filetypestringrequired

File Format: image/jpeg | image/png | application/pdf

notify_urlstring

Response

Get pre-signed urls or error message

customer_idstring<uuid>

CustomerID of the customer

optionsobject
Show options properties
filenamestring
filetypestring

File Format: image/jpeg | image/png | application/pdf

error_messagestring

Description of error encountered while creating upload url

presigned_urlstring

S3 signed url to upload the document

idstring<uuid>

Poi Upload request ID on success

Invalid Payload

messagestring
errorsobject[]
Show errors properties
pathstring
messagestring
errorCodestring

Invalid/Expired Access Token

messagestring
errorsobject[]
Show errors properties
pathstring
messagestring

Server Error

messagestring
Request
curl -X POST "https://api.triple-a.work/kyc-api/v1/customers/poi" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token>" \
  -d '{
  "files": [
    {
      "customer_id": "6d282e8c-128e-4153-ad65-601930a94e02",
      "options": {
        "filename": "example.txt",
        "filetype": "text/plain"
      },
      "notify_url": "https://example.com/notify"
    },
    {
      "customer_id": "4d37cbdc-9dbb-4604-82a7-8f8753366a68",
      "options": {
        "filename": "example.jpeg",
        "filetype": "image/jpeg"
      },
      "notify_url": "https://example.com/notify"
    }
  ]
}'
Response
[
  {
    "customer_id": "6d282e8c-128e-4153-ad65-601930a94e02",
    "options": {
      "filename": "example.txt",
      "filetype": "text/plain"
    },
    "error_message": "Invalid File Extension"
  },
  {
    "customer_id": "4d37cbdc-9dbb-4604-82a7-8f8753366a68",
    "options": {
      "filename": "example.jpeg",
      "filetype": "image/jpeg"
    },
    "presigned_url": "https://<s3-url-to-upload-image>",
    "id": "82b786cd-c91e-40a7-8e06-db70e9a73787"
  }
]