curl --request DELETE \
--url 'https://api.hopae.com/connect/v2/verifications/{verificationId}' \
--user '{appId}:{appSecret}'
{
"error": {
"code": "SESSION_VERIFICATION_NOT_FOUND",
"message": "Verification not found",
"details": {}
},
"request_id": "req_01J8XQ3V9K2M7N4P"
}{
"error": {
"code": "SESSION_INVALID_STATUS_TRANSITION",
"message": "Already finished",
"details": {}
},
"request_id": "req_01J8XQ3V9K2M7N4P"
}Verifications
Cancel Verification
Cancel a verification session that has not finished.
DELETE
/
verifications
/
{verificationId}
curl --request DELETE \
--url 'https://api.hopae.com/connect/v2/verifications/{verificationId}' \
--user '{appId}:{appSecret}'
{
"error": {
"code": "SESSION_VERIFICATION_NOT_FOUND",
"message": "Verification not found",
"details": {}
},
"request_id": "req_01J8XQ3V9K2M7N4P"
}{
"error": {
"code": "SESSION_INVALID_STATUS_TRANSITION",
"message": "Already finished",
"details": {}
},
"request_id": "req_01J8XQ3V9K2M7N4P"
}Cancels a verification session. The session moves to
cancelled and can no longer be completed by the user. It stays readable through Get Verification Status.
Headers
string
required
Basic <base64(appId:appSecret)>. See Authentication.Path Parameters
string
required
The session id.
Response
Returns an empty response with HTTP status204 on success.
curl --request DELETE \
--url 'https://api.hopae.com/connect/v2/verifications/{verificationId}' \
--user '{appId}:{appSecret}'
Errors
| HTTP | Code | When |
|---|---|---|
| 404 | SESSION_VERIFICATION_NOT_FOUND | Unknown id, a session of another app, or an environment mismatch |
| 409 | SESSION_INVALID_STATUS_TRANSITION | The session is already completed, failed, or cancelled |
Cancelling does not notify the eID provider. A provider-side session the user already opened may stay alive until it expires on its own, but its result will never be applied to the cancelled verification.
Authorizations
Basic base64(appId:appSecret). See Authentication.
Path Parameters
The session id.
Response
Cancelled.