{"id":356,"date":"2025-09-09T14:34:59","date_gmt":"2025-09-09T14:34:59","guid":{"rendered":"https:\/\/developers.10npay.com\/?post_type=docs&p=1547"},"modified":"2026-05-21T14:21:57","modified_gmt":"2026-05-21T14:21:57","password":"","slug":"initiate-external-identification-api","status":"publish","type":"docs","link":"https:\/\/developers.10npay.com\/bg\/docs\/initiate-external-identification-api\/","title":{"rendered":"Initiate External Identification API"},"content":{"rendered":"

Initiate External Identification<\/h1>\n

Starts the external identification flow (Onfido + document signing) and returns the URL the client must open in a browser or WebView.<\/p>\n

Endpoint<\/h2>\n
POST https:\/\/api-test.10npay.com\/Enrollment\/initiate-external-identification\n<\/code><\/pre>\n
Headers<\/h2>\n
    \n
  • Authorization: Bearer <access_token><\/code><\/li>\n
  • Content-Type: application\/json<\/code><\/li>\n<\/ul>\n
    Request Body<\/h2>\n
    {\n  \"userId\": 2077,\n  \"isRestartIdentification\": false,\n  \"localTimezone\": \"Europe\/Sofia\",\n  \"userAgent\": \"Chrome\/119.0\",\n  \"browserLanguage\": \"bg\",\n  \"userLanguage\": \"bg\",\n  \"deviceName\": \"MacBook Pro\",\n  \"correlationType\": 0\n}\n<\/code><\/pre>\n\n\n\n\n\n\n\n\n
    Field<\/th>\nType<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    userId<\/code><\/td>\ninteger<\/td>\nUser identifier. Required.<\/td>\n<\/tr>\n
    isRestartIdentification<\/code><\/td>\nboolean<\/td>\nIf true<\/code>, force a brand-new session even if one is in progress.<\/td>\n<\/tr>\n
    localTimezone<\/code>, userAgent<\/code>, browserLanguage<\/code>, userLanguage<\/code>, deviceName<\/code><\/td>\nstring<\/td>\nOptional metadata used for auditing\/support.<\/td>\n<\/tr>\n
    correlationType<\/code><\/td>\ninteger (enum)<\/td>\nOptional context flag (default 0<\/code>).<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Response — 200 OK<\/h2>\n
    {\n  \"videoIdentificationUrl\": \"https:\/\/onfido-session-url\",\n  \"videoIdentificationStatus\": \"STARTED\",\n  \"message\": \"\"\n}\n<\/code><\/pre>\n
    Open videoIdentificationUrl<\/code> to render the Onfido flow (ID capture, liveness, document signing).<\/p>\n
    Errors<\/h2>\n
      \n
    • 400 Bad Request<\/strong> — user not eligible (missing additional data, wrong state).<\/li>\n
    • 401 Unauthorized<\/strong> — missing\/expired token.<\/li>\n
    • 404 Not Found<\/strong> — unknown userId<\/code>.<\/li>\n
    • 5xx<\/strong> — gateway or backend error.<\/li>\n<\/ul>\n
      Flow Notes<\/h2>\n
        \n
      • After the user completes Onfido, your client will be redirected to the Success\/Fail URLs configured in the portal.<\/li>\n
      • Immediately after a Success redirect, start polling GET \/Enrollment\/{id}\/0\/true\/get-identification-process-status<\/code> (Phase A) until SIGN_SESSION_ID_SUCCESSFULLY_CREATED<\/code>.<\/li>\n
      • Then open the returned signing URL (Signhost) and, after completion, poll again (Phase B) until DOCUMENT_SIGN_SUCCESS<\/code>.<\/li>\n
      • Finally, call POST \/Enrollment\/finalize-external-identification<\/code> to persist the outcome.<\/li>\n<\/ul>","protected":false},"excerpt":{"rendered":"
        Initiate External Identification Starts the external identification flow (Onfido + document signing) and returns the URL the client must open in a browser or WebView. Endpoint POST https:\/\/api-test.10npay.com\/Enrollment\/initiate-external-identification Headers Authorization: Bearer <access_token> Content-Type: application\/json Request Body { “userId”: 2077, “isRestartIdentification”: false, “localTimezone”: “Europe\/Sofia”, “userAgent”: “Chrome\/119.0”, “browserLanguage”: “bg”, “userLanguage”: “bg”, “deviceName”: “MacBook Pro”, “correlationType”: 0 } […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"doc_category":[58],"doc_tag":[],"knowledge_base":[33],"class_list":["post-356","docs","type-docs","status-publish","hentry","doc_category-web-identification","knowledge_base-10npay"],"year_month":"2026-05","word_count":218,"total_views":0,"reactions":{"happy":0,"normal":0,"sad":0},"author_info":{"name":"10npaydev","author_nicename":"10npaydev","author_url":"https:\/\/developers.10npay.com\/bg\/author\/10npaydev\/"},"doc_category_info":[{"term_name":"Web identification","term_url":"https:\/\/developers.10npay.com\/bg\/docs\/10npay\/web-identification\/"}],"doc_tag_info":[],"knowledge_base_info":[{"term_name":"10npay","term_url":"https:\/\/developers.10npay.com\/bg\/docs\/10npay\/","term_slug":"10npay"}],"knowledge_base_slug":["10npay"],"_links":{"self":[{"href":"https:\/\/developers.10npay.com\/bg\/wp-json\/wp\/v2\/docs\/356","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developers.10npay.com\/bg\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/developers.10npay.com\/bg\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/developers.10npay.com\/bg\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/developers.10npay.com\/bg\/wp-json\/wp\/v2\/comments?post=356"}],"version-history":[{"count":1,"href":"https:\/\/developers.10npay.com\/bg\/wp-json\/wp\/v2\/docs\/356\/revisions"}],"predecessor-version":[{"id":389,"href":"https:\/\/developers.10npay.com\/bg\/wp-json\/wp\/v2\/docs\/356\/revisions\/389"}],"wp:attachment":[{"href":"https:\/\/developers.10npay.com\/bg\/wp-json\/wp\/v2\/media?parent=356"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/developers.10npay.com\/bg\/wp-json\/wp\/v2\/doc_category?post=356"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/developers.10npay.com\/bg\/wp-json\/wp\/v2\/doc_tag?post=356"},{"taxonomy":"knowledge_base","embeddable":true,"href":"https:\/\/developers.10npay.com\/bg\/wp-json\/wp\/v2\/knowledge_base?post=356"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}