🛂#6 Passport Scan

#6.1 Select National Id Step (False) :

This API is only required when national id or passport configuration is enabled .

If you enable the National ID or Passport option in the Personality Confirmation section of the Organization Configuration, then during the onboarding process you must specify the type of document you want to use for onboarding — either National ID or Passport.

post
Authorizations
Path parameters
isNationalIDbooleanRequired

True if onboarding using National Id, false if passport

Example: true
Responses
200

Success

No content
post
/Onboarding/api/v1/onboarding/Request/SelectNationalIdStep/{isNationalID}
POST /Onboarding/api/v1/onboarding/Request/SelectNationalIdStep/{isNationalID} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

#6.2 Upload Passport Image :

This API is to upload passport image.

post
Authorizations
Body
imagestringRequired

This attribute is base64 front-side, back-side or passport image.

Responses
200

Success

application/json
post
/Onboarding/api/v1/onboarding/Passport/UploadPassportImage
POST /Onboarding/api/v1/onboarding/Passport/UploadPassportImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "image": "text"
}
{
  "isSuccess": true,
  "message": "text",
  "errorCode": "text",
  "passportData": {
    "customerId": "text",
    "firstNameEn": "text",
    "familyNameEn": "text",
    "fullNameEn": "text",
    "fullNameAr": "text",
    "firstNameAr": "text",
    "familyNameAr": "text",
    "birthdate": "2025-11-06T00:27:42.145Z",
    "expirationDate": "2025-11-06T00:27:42.145Z",
    "gender": "text",
    "documentNumber": "text",
    "documentCode": "text",
    "issuingAuthority": "text",
    "nationality": "text",
    "visualZone": "text",
    "photo": "text"
  }
}

#6.3 Approve Passport Info:

This API is to approve the OCR result data of passport image.

post
Authorizations
Body
fullNameArstring | nullableOptional

Translated arabic full name, this attribute can be used when traslate feature is enabled at admin panel configuration steps.

Example: أحمد محمد أحمد محمد
Responses
200

Success

application/json
post
/Onboarding/api/v1/onboarding/Passport/Approve
POST /Onboarding/api/v1/onboarding/Passport/Approve HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "fullNameAr": "أحمد محمد أحمد محمد"
}
{
  "status": 0
}
Previous#5 National Id ScanNext#7 BiometricTest

Last updated