🔦General API

# Get List Of Countries :

get

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Responses

200

Success

application/json

idinteger · int32Optional

Country unique identifier

Example: 10

namestring · nullableOptional

Country name

Example: Egypt

codestring · nullableOptional

Country international code

Example: 20

countryISOCodestring · nullableOptional

Country international ISO code

Example: EG

400

BadRequest

application/json

401

Unauthorized

application/json

get

/Onboarding/api/v1/Lookups/Countries

HTTPcURLJavaScriptPython

GET /Onboarding/api/v1/Lookups/Countries HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "10",
    "name": "Egypt",
    "code": "20",
    "countryISOCode": "EG"
  }
]

This API is to return list of countries

# Get Request Current Step :

This API is to get the current and next onboarding steps for the current request.

get

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Responses

200

Success

application/json

currentStepIdinteger · int32Optional

Current onboarding step

Example: 5

nextStepIdinteger · int32 · nullableOptional

Next onboarding step, it can be null when the request is in last step

Example: 5

currentStepSettingsIdinteger · int32 · nullableOptional

Current onboarding step setting Id

Example: 4

statusinteger · enumOptionalPossible values:

400

BadRequest

application/json

401

Unauthorized

application/json

get

/Onboarding/api/v1/onboarding/Request/GetCurrentStep

HTTPcURLJavaScriptPython

GET /Onboarding/api/v1/onboarding/Request/GetCurrentStep HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "currentStepId": "5",
  "nextStepId": "5",
  "currentStepSettingsId": "4",
  "currentStepSettings": {
    "registrationStepId": "1",
    "registrationStepName": "تأكيد الهوية",
    "minAccuracyThreshold": "30.0",
    "maxAccuracyThreshold": "65.0",
    "organizationRegStepSettings": [
      {
        "registrationStepSettingId": "4",
        "registrationStepSettingName": "البطاقة فقط"
      }
    ]
  },
  "nextStepSettings": {
    "registrationStepId": "1",
    "registrationStepName": "تأكيد الهوية",
    "minAccuracyThreshold": "30.0",
    "maxAccuracyThreshold": "65.0",
    "organizationRegStepSettings": [
      {
        "registrationStepSettingId": "4",
        "registrationStepSettingName": "البطاقة فقط"
      }
    ]
  },
  "status": 1
}