Case manaegment - change status

The following endpoint allows to change the status of the case via API. If you would like to find out more information about possible status changes check our guide Risk assessment process.

Start

post
/api/v1/verifications/{verification_id}/state/start
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_idstringRequiredExample: 47f0bf5c-5329-4bd8-ad24-2603b697e5e7
Body
Responses
200

OK

application/json
post
/api/v1/verifications/{verification_id}/state/start

Request Risk Score Update

post
/api/v1/verifications/{verification_id}/state/request_risk_score_update
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_idstringRequiredExample: 81e38c0b-66c9-4f69-82c2-8688ea033e75
Body
Responses
post
/api/v1/verifications/{verification_id}/state/request_risk_score_update
default

default

Cancel Risk Score Update

post
/api/v1/verifications/{verification_id}/state/cancel_risk_score_update
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_idstringRequiredExample: 81e38c0b-66c9-4f69-82c2-8688ea033e75
Body
Responses
post
/api/v1/verifications/{verification_id}/state/cancel_risk_score_update
default

default

Request Data Update

post
/api/v1/verifications/{verification_id}/state/request_data_update
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_idstringRequiredExample: c859559c-1f21-427b-81a8-980ba52e4ca4
Query parameters
completeness_profile_idstringOptionalExample: b80743bc-bffe-48b1-9289-cd6aad0ab854
Body
Responses
200

OK

application/json
post
/api/v1/verifications/{verification_id}/state/request_data_update
200

OK

Cancel Data Update

post
/api/v1/verifications/{verification_id}/state/cancel_data_update
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_idstringRequiredExample: df786f41-241b-43bc-a4b9-0eb90f7be8e9
Body
Responses
200

OK

application/json
post
/api/v1/verifications/{verification_id}/state/cancel_data_update

QA

post
/api/v1/verifications/{verification_id}/state/qa
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_idstringRequiredExample: 2d926af7-2397-4296-865a-4e7cd93017c0
Body
assessmentstringOptional

enum: risk_low, risk_medium, risk_high

Example: risk_low
assessment_commentstringOptional

string

Example: Lorem ipsum dolor sit amet
Responses
200

OK

application/json
post
/api/v1/verifications/{verification_id}/state/qa

Back to Compliance

post
/api/v1/verifications/{verification_id}/state/back_to_compliance
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_idstringRequiredExample: 2d926af7-2397-4296-865a-4e7cd93017c0
Body
qa_commentstringOptional

string

Example: Lorem ipsum dolor sit amet
Responses
200

OK

application/json
post
/api/v1/verifications/{verification_id}/state/back_to_compliance

Complete

post
/api/v1/verifications/{verification_id}/state/complete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_idstringRequiredExample: 2d926af7-2397-4296-865a-4e7cd93017c0
Body
assessmentstringOptional

enum: risk_low, risk_medium, risk_high

Example: risk_medium
assessment_commentstringOptional

string

Example: Lorem ipsum dolor sit amet
qa_commentstringOptional

string

Example: Lorem ipsum dolor sit amet
Responses
200

OK

application/json
post
/api/v1/verifications/{verification_id}/state/complete
200

OK

Rejected

post
/api/v1/verifications/{verification_id}/state/rejected
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_idstringRequiredExample: 2d92fc77-c14c-4c6b-bed9-acfe015696ca
Body
rejection_commentstringOptionalExample: Lorem ipsum dolor sit amet
Responses
200

OK

application/json
post
/api/v1/verifications/{verification_id}/state/rejected
200

OK

Reopen

post
/api/v1/verifications/{verification_id}/state/reopen
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
verification_idstringRequiredExample: 2d926af7-2397-4296-865a-4e7cd93017c0
Body
Responses
200

OK

application/json
post
/api/v1/verifications/{verification_id}/state/reopen
200

OK

Last updated

Was this helpful?