Skip to main content
GET
/
verifications
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const verification = await client.verifications.retrieve('verf_xxxxxxxxxxxxx');

console.log(verification.id);
{
  "id": "verf_xxxxxxxxxxxxx",
  "status": "requires_input",
  "last_error_code": "abandoned",
  "last_error_reason": "Document image was too blurry to read."
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

​
id
string
required

The unique identifier of the verification to retrieve.

Example:

"verf_xxxxxxxxxxxxx"

Response

A successful response

An identity verification session used to confirm a user's identity for payout account eligibility.

​
id
string
required

The unique identifier for the verification.

Example:

"verf_xxxxxxxxxxxxx"

​
status
enum<string>
required

The current status of this verification session.

Available options:
requires_input,
processing,
verified,
canceled,
created,
started,
submitted,
approved,
declined,
resubmission_requested,
expired,
abandoned,
review
​
last_error_code
enum<string> | null
required

The most recent error code returned during verification. Null if no error has occurred.

Available options:
abandoned,
consent_declined,
country_not_supported,
device_not_supported,
document_expired,
document_type_not_supported,
document_unverified_other,
email_unverified_other,
email_verification_declined,
id_number_insufficient_document_data,
id_number_mismatch,
id_number_unverified_other,
phone_unverified_other,
phone_verification_declined,
selfie_document_missing_photo,
selfie_face_mismatch,
selfie_manipulated,
selfie_unverified_other,
under_supported_age
​
last_error_reason
string | null
required

A human-readable explanation of the most recent verification error. Null if no error has occurred.

Example:

"Document image was too blurry to read."