💡#2 Get Configurations

This API returns a list of onboarding steps that were configured by organization admin on admin panel.

get

Authorizations

JWT

AuthorizationstringRequired

Please insert JWT with Bearer into field

Responses

200

Success

application/json

registrationStepIdinteger · int32Required

The Identifier of onboarding step (registration step)

Example: 1

registrationStepNamestringRequired

The name of onboarding step (registration step)

Example: تأكيد الهوية

minAccuracyThresholdnumber · double · nullableOptional

If the confidence of OCR and scanned images less than minAccuracyThreshold it is rejected automatically. This attribute is used for confidence of National ID, Passport or selfie images and can be configured from admin panel

Example: 30.0

maxAccuracyThresholdnumber · double · nullableOptional

If the confidence of OCR and scanned images greater than maxAccuracyThreshold it is accepted automatically. This attribute is used for confidence of National ID, Passport or selfie images and can be configured from admin panel

Example: 65.0

401

Unauthorized

application/json

get

/Onboarding/api/v1/Configuration/GetStepsConfiguration

HTTPcURLJavaScriptPython

GET /Onboarding/api/v1/Configuration/GetStepsConfiguration HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

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