End session

POST

/v2/sessions/{id}/end

Conclude the session. Optionally runs a SIM-swap check when a phone number is provided. Does not compute a combined decision across the calls made in the session — each verification call carries its own decision.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

id

required

string format: uuid

Request Body

object

phone_number

Phone number for the optional SIM-swap fraud check.

string

Responses

200

Session ended.

object

data

Endpoint-specific payload; omitted when the operation returns no data.

decision

Scoring decision computed for the request when a scoring system applies.

object

status

Decision status from the scoring engine (e.g. pass, fail, refer).

string

score

number

reasons

Array<string>

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

400

Bad Request / Parameter Validation Failed.

object

error

required

object

code

required

string

invalid_request

message

required

Human-readable message; a string, or a field-error array for validation failures.

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

401

Unauthorized / Missing or Invalid Authentication Credentials.

object

error

required

object

code

required

string

invalid_request

message

required

Human-readable message; a string, or a field-error array for validation failures.

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

404

Not Found / Specified Resource (User, Session, Reference Image, etc.) does not exist.

object

error

required

object

code

required

string

invalid_request

message

required

Human-readable message; a string, or a field-error array for validation failures.

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

500

Internal Server Error.

object

error

required

object

code

required

string

invalid_request

message

required

Human-readable message; a string, or a field-error array for validation failures.

meta

required

object

request_id

required

string

message

string

warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>