View Categories

Get Identification Process Status

1 min read

Table of Contents

Get Identification Process Status #

Polls the current state of the external identification flow (Onfido + document signing). Use it immediately after each Success redirect.

Endpoint #

GET https://api-test.10npay.com/Enrollment/{id}/{userType}/true/get-identification-process-status

Path Parameters #

Name Type Description
id integer User identifier (same as in other onboarding calls).
userType integer (enum) 0 for Individuals, 1 for merchant flows.
true boolean literal Always pass true; it indicates that the client already received the success redirect and wants the latest status.

Headers #

  • Authorization: Bearer <access_token>

Response — 200 OK #

{
  "videoIdentificationUrl": "https://signing-url-if-applicable",
  "videoIdentificationStatus": "SIGN_SESSION_ID_SUCCESSFULLY_CREATED",
  "message": ""
}

Typical statuses #

  • PROCESSING — still waiting for the upstream provider.
  • SIGN_SESSION_ID_SUCCESSFULLY_CREATED — Phase A complete; use the returned URL to open the document signing flow.
  • DOCUMENT_SIGN_SUCCESS — Phase B complete; proceed to POST /Enrollment/finalize-external-identification.
  • ERROR / other vendor-specific codes — treat as failure and prompt the user to restart.

Errors #

  • 400/404 — invalid parameters or unknown user/session.
  • 401 — missing/expired token.
  • 5xx — transient issues (retry).

Polling Guidance #

  • Poll every 2–5 seconds with a client-side timeout (e.g., 2 minutes).
  • Stop once you receive SIGN_SESSION_ID_SUCCESSFULLY_CREATED (Phase A) or DOCUMENT_SIGN_SUCCESS (Phase B).
  • If no status change occurs within the timeout, offer the user the option to restart the identification.
What are your Feelings