Skip to main content

Verification Requests

This guide covers endpoints related to managing verification requests.

Create Verification Request

Creates a new verification request for a user.

Endpoint

POST /verification/verification/requests

Description

Initiate a verification workflow. The user in verified_by_id will be notified and can approve or deny the request. The verifier is notified at their registered notification_url.

Required Information

NameTypeRequiredDescription
verified_by_idintegerYesID of the user performing the verification.
verification_of_idintegerYesID of the user being verified.

Optional Information

You can specify which fields to verify by setting them to true.

Get Verification Requests

Retrieves all verification requests.

Endpoint

GET /verification/verification-requests

Description

Returns verification requests involving the current user, including ones they created and ones where they are asked to verify someone else.

Delete Verification Request

Deletes a verification request by its ID.

Endpoint

DELETE /verification/verification-request/{request_id}

Description

Delete a verification request by request_id. Either the requestor or the requested verifier can perform this action.