🛂#6 Passport Scan

#6.1 Select National Id Step (False) :

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

post
Authorizations
Path parameters
isNationalIDbooleanRequired
Header parameters
Accept-LanguageStringOptional
AuthorizationstringOptional

ex: Bearer

Responses
200
Success
post
POST /api/v1/onboarding/Request/SelectNationalIdStep/{isNationalID} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

#6.2 Upload Passport Image :

post
Authorizations
Header parameters
Accept-LanguageStringOptional
AuthorizationstringOptional

ex: Bearer

Body
customerIdstring | nullableOptional
imagestring | nullableOptional
Responses
200
Success
post
POST /api/v1/onboarding/Passport/UploadPassportImage HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "customerId": "text",
  "image": "text"
}
{
  "isSuccess": true,
  "message": "text",
  "passportData": {
    "customerId": "text",
    "firstNameEn": "text",
    "familyNameEn": "text",
    "fullNameEn": "text",
    "fullNameAr": "text",
    "firstNameAr": "text",
    "familyNameAr": "text",
    "birthdate": "2025-07-01T03:55:57.524Z",
    "expirationDate": "2025-07-01T03:55:57.524Z",
    "gender": "text",
    "documentNumber": "text",
    "documentCode": "text",
    "issuingAuthority": "text",
    "nationality": "text",
    "visualZone": "text"
  }
}

#6.3 Approve Passport Info:

post
Authorizations
Header parameters
Accept-LanguageStringOptional
AuthorizationstringOptional

ex: Bearer

Body
fullNameArstring | nullableOptional
Responses
200
Success
post
POST /api/v1/onboarding/Passport/Approve HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "fullNameAr": "text"
}
No content
Previous#5 National Id ScanNext#7 BiometricTest

Last updated