POST
/
scanDocuments
curl --request POST \
  --url https://gateway.finhub.cloud/kyc/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
headerrequired

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
country
enum<string>
Available options:
UAE,
OMN,
PAK,
SAU,
BHR,
KWT,
QAT,
NLD,
OTHER
documentType
enum<string>
required
Available options:
PASSPORT,
ID,
DRIVER_LICENCE,
VEHICLE_LICENCE,
VISA_DOCUMENT,
SELFIE,
UTILITY_BILL,
PROOF_OF_RESIDENCE,
BANK_STATEMENT
frontImage
string
required
backImage
string
disableExpiryValidation
boolean
required
exportFaceImage
boolean
required
startSession
boolean

Response

default - application/json
sessionId
string
front
object
back
object
analysis
object