POST
/
scanDocuments
curl --request POST \
  --url https://gateway.finhub.cloud/kyc/1.0.0/scanDocuments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-token: <x-token>' \
  --data '{
  "country": "UAE",
  "documentType": "PASSPORT",
  "frontImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDA",
  "backImage": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDA",
  "disableExpiryValidation": true,
  "exportFaceImage": false,
  "startSession": true
}'
{
  "requireManualReview": true,
  "sessionId": "e63fd1c3-07a4-4b86-84dc-e93289ab3eda",
  "front": {
    "secondaryId": "MARIA",
    "primaryId": "DELA CRUZ",
    "dateOfBirth": "800316",
    "dateOfExpiry": "210626",
    "documentNumber": "P0000000A",
    "nationality": "PHL",
    "issuer": "PHL",
    "sex": "F",
    "documentCode": "P",
    "mrzText": "P<PHLDELA<CRUZ<<MARIA<<<<<<<<<<<<<<<<<<<<<<<\nP0000000A0PHL8003166F2106269<<<<<<<<<<<<<<02",
    "mrzVerified": false,
    "chipAvailable": true
  },
  "back": {},
  "analysis": {
    "front": {
      "copy": 100
    }
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
X-token
string
required

authentication token from /authorize response

Body

application/json

Sample Payload

The body is of type object.

Response

default - application/json

Default response

The response is of type object.