Endpoint & purpose
PUT /v1/perform/process. Execute the process with conditional evidence according to
process type.
Perform verification with multipart payload/evidence and process-type-dependent fields.
Perform the check using a JSON payload plus optional evidence file; conditional fields depend on process_type.
/v1/perform/process
Perform the check using a JSON payload plus optional evidence file; conditional fields depend on process_type.
| Field | Type | Presence | Description |
|---|---|---|---|
payload |
Object | M | JSON object sent as multipart text |
evidence |
Byte Array | M/O | File upload when required by process type |
{
"payload": {
"subject_id": "<SUBJECT_ID>",
"process_id": "<PROCESS_ID>",
"lang": "en"
},
"evidence": "<BINARY_FILE_WHEN_REQUIRED>"
}
{
"status": 0,
"message": "SUCCESSFULLY",
"dtis_id": "<DTIS_TRANSACTION_ID>",
"process_type": "LIVE_FACIAL_MATCHING_EKYC",
"perform_result": {
"final_result": {
"match_result": true,
"liveness": true,
"claim_sources": {
"JWT": "<SIGNED_JWT>"
}
}
}
}
Conditional fields are not presented as universally mandatory.
identity_documentM/OPA · live facial · fingerprint · facial matching
evidence_upload_typeM/OKYC · LIVENESS · VERIFY · MATCHED; selected face/liveness processes
otpM/OEMAIL_AUTHENTICATION · MOBILE_AUTHENTICATION
framesM/OFace/liveness process types
fingerprintM/OFingerprint matching
left_fingerprints / right_fingerprintsM/OFINGERPRINT_ENROLLING
pa_dataM/OPASSIVE_AUTHENTICATION
os_typeM/OPASSIVE_AUTHENTICATION
reader_snM/OPA on WIN according to source
session_key_dataM/OPASSIVE_AUTHENTICATION
PUT · /v1/perform/process
PUT /v1/perform/process. Execute the process with conditional evidence according to
process type.
Bearer . Do not replace this mechanism with
assumptions from legacy documentation.
{
"payload": {
"process_type": "PASSIVE_AUTHENTICATION",
"operating_system": "WINDOWS"
},
"evidence": "<BINARY_EVIDENCE>"
}
{
"process_status": "ACCEPTED",
"perform_result": {
"passive_authentication_status": "PARTIAL_VALID"
},
"x-billcode-id": "<BILLCODE_ID>"
}