API Reference

Get a biometric identity verification request

get
https://api.wingspan.app/v3/compliance/biometric-identity-verification-requests/

Retrieve a single BiometricIdentityVerificationRequest by ID. Either party may read it.

Once status is Complete or Failed, the payee's verification is included inline under biometricIdentityVerification — reaching either status means the payee agreed to share it. While the request is Pending, that key is absent rather than null, and resultFiles is empty.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of a BiometricIdentityVerificationRequest.

Headers
string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 14 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 14 days ago

Did this page help you?