/v1/sessions/{id}/attempts

  • Updated on Mar 18, 2025
Prev Next
Get
/v1/sessions/{id}/attempts

Returns the list of attempt objects associated with the specific session id = {id}

 

User-defined statuses in Veriff Customer Portal

Can be used to query the user-defined statuses data if those have been set in the Veriff Customer Portal. For more information see the Adding user-defined Statuses to Sessions[↗] article in Veriff Knowledge Base (you need an active account with Veriff to access the article).


Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.



Security
API Key
Header parameter namex-auth-client

Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")

Header parameters
x-hmac-signature
stringRequired

Session id signed with the shared secret key

Path parameters
id
stringRequired

Session id

Responses
200
Expand All
object
status
string

API request status

Examplesuccess
verifications
Array of object (SessionAttemptsResponseVerification)

List of data identifying the attempts in the verification session

Example[ { "id": "a1c68aea-7f4d-478d-80ab-ca9356074f69", "status": "approved", "userDefinedData": [ { "status": "Custom status for suspicious attempt", "statusCode": "custom_status_for_suspicious_attempt", "reason": "Looks like velocity abuse", "reasonCode": "looks_like_velocity_abuse", "createdAt": "2023-09-18T08:41:41.606Z" } ], "createdTime": "2023-09-18T08:33:30.047Z" }, { "id": "f2270684-8c51-4d03-88eb-dafd43e8b486", "status": "resubmission_requested" }, { "id": "a1c68aea-7f4d-478d-80ab-ca9356074f69", "status": "approved", "userDefinedData": [ { "status": "Custom status for suspicious attempt", "statusCode": "custom_status_for_suspicious_attempt", "reason": "The document used in this attempt is clearly a cut-out", "reasonCode": null, "createdAt": "2023-09-18T08:41:41.606Z" } ], "createdTime": "2023-09-18T08:33:30.047Z" }, { "id": "f2270684-8c51-4d03-88eb-dafd43e8b486", "status": "resubmission_requested" } ]
object
id
string

Unique identifier (ID) of the attempt

Example123e4567-e89b-12d3-a456-426614174000
status
string

Verification session status

Valid values[ "created", "started", "submitted", "resubmission_requested" ]
Examplecreated
userDefinedData
Array of object (UserStatus)

Array of objects describing the custom statuses defined by the user in Veriff Customer Portal

object
status
string

Name of the custom end-user defined status as set in the Veriff Customer Portal

ExampleApproved
statusCode
string

Autogenerated code for the custom end-user defined status

Exampleapproved
reason
string

Name of the custom end-user defined reason as set in the Veriff Customer Portal. If the user has selected the "Custom" reason for the status and typed an explanation to the text box, then the explanation is sent in this field

ExampleApproved by user
reasonCode
string

Autogenerated code for the custom end-user defined reason. It is null when the user has selected the "Custom" reason for the status and typed an explanation to the text box. This explanation is sent in the reason parameter

Exampleapproved_by_user
createdAt
string (Combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SS+Timezone Offset)

Creation time of the user-defined status for the verification attempt

Example2020-01-01T00:00:00.000Z
createdTime
string (Combined ISO 8601 date and time in UTC, YYYY-MM-DDTHH:MM:SS+Timezone Offset)

Timestamp of when the attempt was created

Example2020-01-01T00:00:00.000Z
400

Bad request

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleValidation failed
401

Unauthorized

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleMandatory X-AUTH-CLIENT header containing the API key is missing from the request.
404

Session not found

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleResource not found
500

Internal server error

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleSomething went wrong