Skip to main content
POST
identity.verification.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by identity.verification.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$

Response

The result

status
string
required

Where the verification stands: not_started, in_progress, awaiting_user, in_review, approved, declined, resubmitted, expired or abandoned.

checks
object[]
required

One row per check the flow ran, with its outcome and warning codes.

sessionKind
enum<string>

Whether the session verified a person or a business.

Available options:
person,
business
sessionNumber
integer

Sequential number of the verification in your account.

Required range: -9007199254740991 <= x <= 9007199254740991
createdAt
string

When the verification started, ISO 8601.

expiresAt
string

When the verification link stops working, ISO 8601.

endUserId
string

The endUserId the verification was created with, when one was.

name
string

Full name read from the verified ID document.

firstName
string

Given name(s) read from the ID document.

lastName
string

Family name(s) read from the ID document.

dateOfBirth
string

Date of birth read from the ID document, YYYY-MM-DD.

documentType
string

Kind of ID document verified, for example Passport.

documentSubtype
string

Finer document kind, for example EPASSPORT.

documentNumber
string

Document number read from the ID document.

personalNumber
string

Personal or national number printed on the document, when present.

dateOfIssue
string

When the document was issued, YYYY-MM-DD.

documentExpiry
string

When the document expires, YYYY-MM-DD.

issuingCountry
string

Country that issued the document, as a code.

gender
string

Sex as printed on the document: M, F or U.

nationality
string

Nationality read from the document, as a code.

addressLine
string

Address as printed on the document, when present.