Skip to main content

CreateSessionRequest

All fields are optional — an empty body creates a session with your configuration's defaults.

credentialTypestring

Type of credential to request. Defaults to your configuration's system default.

Possible values: <= 512 characters

Example: VerifiedPerson
presentationDefinitionIdstring

Specific DIF presentation definition to use. Defaults to your configuration's system default.

Possible values: <= 256 characters

Example: verified-person-v1
externalIdstring

Your internal correlation ID, echoed in all responses and callbacks. See Using externalId for Correlation.

Possible values: <= 256 characters

Example: kyc-check-99887
ttlSecondsinteger

Session TTL in seconds. Omit it to use your verifier configuration's default. A value above your configuration's maximum (300 when it sets none) returns 400 invalid-input.

Possible values: >= 5

Default value: 60
Example: 120
CreateSessionRequest
{
"credentialType": "VerifiedPerson",
"presentationDefinitionId": "verified-person-v1",
"externalId": "kyc-check-99887",
"ttlSeconds": 120
}