Issues a new token for an ACTIVE existing onboarding session, for example when a user starts onboarding on desktop and continues on mobile. The session is located by exactly one of: its onboarding-link uuid, its interviewId, or its externalId (the value supplied as externalId on /omni/start; deprecated, temporary available - will be removed soon). Providing zero or more than one identifier is rejected with 400. With useUuidOnlyOnce enabled the uuid is consumed by this call and can not be reused.
API reference, Interview
Continue onboarding session
POST
https://demo-api.incodesmile.com/omni/session/continueHeaders
Request body
application/json
Onboarding-link uuid identifying the session to continue. Exactly one of uuid, interviewId or externalId must be provided. With useUuidOnlyOnce enabled the uuid is consumed by this call and can not be reused.
Responses
Response body (application/json)
Identifies the onboarding session that is continued. Can be used for fetching data about that session in future calls.
Internal JWT token used for the future subsequent calls. It is the value for X-Incode-Hardware-Id header in all other calls.
This value is used for connecting to conference call.
Type of the flow used. Could be flow (in most cases), or legacy type configuration (not used anymore).
enum
configurationflowworkflowNumber of seconds after which manual capture button should be shown to the user, while capturing ID when ID is detected.
Number of seconds after which manual capture button should be shown to the user, if ID is not detected.
Number of seconds after which manual capture button should be shown to the user, while capturing selfie.
Number of ID captures after which user should be taken to next screen.
Number of selfie captures after which user should be taken to next screen.
Number of curp validations after which user should be taken to next screen. (only for Mexico)
Response body (application/json)
UTC timestamp in milliseconds
Custom error code or HTTP status code
HTTP status error
Custom error message
Endpoint path
Custom error details
Response body (application/json)
Identifies the onboarding session that is continued. Can be used for fetching data about that session in future calls.
Internal JWT token used for the future subsequent calls. It is the value for X-Incode-Hardware-Id header in all other calls.
This value is used for connecting to conference call.
Type of the flow used. Could be flow (in most cases), or legacy type configuration (not used anymore).
enum
configurationflowworkflowNumber of seconds after which manual capture button should be shown to the user, while capturing ID when ID is detected.
Number of seconds after which manual capture button should be shown to the user, if ID is not detected.
Number of seconds after which manual capture button should be shown to the user, while capturing selfie.
Number of ID captures after which user should be taken to next screen.
Number of selfie captures after which user should be taken to next screen.
Number of curp validations after which user should be taken to next screen. (only for Mexico)