Revoke request

Partners can revoke in-progress and verified requests using the revocation endpoint. This cancels any in-progress requests, voids verified credentials from a user's passport, and deletes associated data. Up to 50 requests can be revoked in a single API call.

For detailed information about authentication requirements and API specifications, see the OpenAPI specification V2.

Request

Authentication requires a JWT token with the revoke.credential OAuth scope.

curl -X POST -L $SEEK_PASS_URL/api/partner/v2/add/requests/revoke.json \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "requests": [
        {
            "request_id": "f25c6425-eed4-4853-95bc-fb19aacd4e1e",
            "reason": "information_discrepancy"
        }
    ]
}'

request_id is the same value supplied as credential_id when the request was created via the Partner Add endpoint.

Revocation reasons

Each request must include a reason with one of the following values:

information_discrepancy — the credential data is incorrect. The candidate may receive an email notification.
user_initiated — the candidate requested deletion. The candidate may receive an email notification.
suspicious_activity — the credential is being revoked due to suspicious activity. No email notification is sent.

Response codes

204 No Content: Request revoked successfullyThe revocation was accepted. No response body is returned. If the request was already revoked, the endpoint still returns 204.

Previous: Check submission status

Next: Integration Flow