Download OpenAPI specification:Download
API for managing identity proofing templates, profiles, sessions, step results, and evidence.
This endpoint creates an identity-proofing session for your predefined profile and returns a sessionId and an sdkToken.
Next steps:
sdkToken and sessionId to your mobile application’s client SDK to initialise the identity proofing flow for the end-user.sessionId to retrieve the results and evidence.| profileId required | string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... Examples: "11111111-1111-1111-1111-111111111111" The unique identifier of your organisation's predefined profile received from Signicat during onboarding. |
| platform required | string (SessionPlatform) Enum: "native" "web" Examples: "native" The client platform that runs the identity-proofing flow, either |
| reference | string Examples: "order-12345" This value is returned in the response under |
object Optional values for external web-view start parameters, keyed by the templateStepId that declares them. |
{- "profileId": "11111111-1111-1111-1111-111111111111",
- "platform": "native",
- "reference": "order-12345"
}{- "sessionId": "22222222-2222-2222-2222-222222222222",
- "sdkToken": "eyJhbGciOi..."
}Returns the current session state and, when available, normalized identity data, checks, and evidence metadata. Poll this endpoint while the session is in progress. Results can be absent until the relevant step or session has completed. Requires an OAuth2 bearer token for the account that owns the session.
| sessionId required | string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... Example: 00000000-0000-0000-0000-000000000000 Session identifier. |
{- "metadata": {
- "id": "22222222-2222-2222-2222-222222222222",
- "platform": "native",
- "reference": "order-12345",
- "status": "COMPLETED",
- "templateName": "Identity verification",
- "profileId": "11111111-1111-1111-1111-111111111111",
- "profileName": "Standard",
- "sessionSteps": [
- {
- "index": 0,
- "sessionStepId": "document-read",
- "stepConfigurationId": "44444444-4444-4444-4444-444444444444",
- "displayName": "Read identity document",
- "stepName": "document-read",
- "stepType": "SDK",
- "status": "SUCCEEDED",
- "createdAt": "2026-10-01T10:00:00Z",
- "updatedAt": "2026-10-01T10:01:00Z"
}
], - "createdAt": "2026-10-01T10:00:00Z",
- "updatedAt": "2026-10-01T10:02:00Z"
}, - "aggregatedIdentity": { },
- "evidenceFiles": [ ]
}Permanently deletes a session and all of its data, including its archived evidence files. This operation is irreversible; retrieve any evidence you must retain before deleting. Requires OAuth2 bearer token with appropriate scope.
| sessionId required | string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... Example: 00000000-0000-0000-0000-000000000000 Session identifier. |
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "code": "string",
- "timestamp": "2022-03-10T16:15:50Z",
- "traceId": "string",
- "invalidParams": [
- null
]
}Returns the result for one session step. Obtain sessionStepId from the session metadata. An account bearer token can read its account's steps; the SDK token returned when creating the same session can also read it. Identity, checks, and evidence are included only when produced by the step.
| sessionId required | string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... Example: 22222222-2222-2222-2222-222222222222 Identifier of the owning session. |
| sessionStepId required | string Example: document-read Step identifier from metadata.sessionSteps[].sessionStepId. |
{- "metadata": {
- "sessionStepId": "document-read",
- "index": 0,
- "displayName": "Read identity document",
- "stepName": "document-read",
- "status": "COMPLETED"
}, - "evidenceFiles": [ ]
}Returns the provider payload recorded for a session step. This is provider-specific data with no stable schema; use the normalized step result when available. Returns an empty object when the step has no raw payload. Requires an OAuth2 bearer token for the account that owns the session; SDK tokens cannot access this endpoint.
| sessionId required | string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... Example: 22222222-2222-2222-2222-222222222222 Identifier of the owning session. |
| sessionStepId required | string Example: document-read Step identifier from metadata.sessionSteps[].sessionStepId. |
{- "providerReference": "example-reference",
- "decision": "approved"
}Lists the evidence files stored for a session. Use each id with the download endpoint. The list contains metadata only and does not download any file. After the session is finalized the list also includes the SESSION_RESULT and SESSION_PLAN evidences produced by Verify, each once its write has succeeded; a failed write is retried, so either can be missing for a while. Requires an OAuth2 bearer token for the account that owns the session.
| sessionId required | string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... Example: 00000000-0000-0000-0000-000000000000 Session identifier. |
[- {
- "id": "33333333-3333-3333-3333-333333333333",
- "evidenceType": "document",
- "contentType": "application/pdf",
- "fileName": "identity-document.pdf",
- "description": "Identity document",
- "source": "provider"
}
]Returns the binary content of an evidence file belonging to a session. Each successful download is metered and the file can only be downloaded a limited number of times. Save the response using its Content-Type and Content-Disposition headers; do not attempt to parse it as JSON. Requires an OAuth2 bearer token for the account that owns the session.
| evidenceId required | string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... Example: 00000000-0000-0000-0000-000000000000 Evidence identifier. |
| sessionId required | string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-... Example: 00000000-0000-0000-0000-000000000000 Session identifier. |
Binary file content
Loaded by the SDK webview with the session token from POST /sessions/token as bearer. Verifies the step belongs to that session, issues a random completion nonce in a cookie and redirects to the configured startUrl with startParams resolved server-side from the session and from the results of earlier steps, appended as query parameters. Any query parameters the client sends are ignored.
| sessionStepId required | string |
Navigated to by the customer page through the verifySucceededUrl or verifyFailedUrl link that the start redirect handed it. Requires the temporary nonce cookie issued by the start endpoint together with the proof query parameter carried by that link. Checks server-side expiry, moves the step to SUCCEEDED or FAILED when accepted, and redirects to the configured continuationUri with sessionStepId and the current status for authenticated attempts. Invalid credentials return 401 without redirecting or clearing the cookie. The SDK reads the authoritative status from Verify.
| outcome required | string |
| proof required | string Completion Proof carried by the verifySucceededUrl or verifyFailedUrl link. |
| sessionStepId required | string Step identifier carried by the completion link. |
| verify-web-view-step required | string Cookie set by the start endpoint, holding the temporary completion nonce. |