Skip to main content
POST
identity.address.verify

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

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
document
string
required

Id of an uploaded file holding the proof-of-address document (a utility bill, bank statement, government letter or similar), up to 15 MB, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
documentPassword
string

Password of an encrypted PDF document. It is used for this call and never stored or echoed.

Maximum string length: 256
expectedAddress
string

Address to check the document against; a mismatch is a warning code in the answer.

Required string length: 1 - 512
expectedCountry
string

Country the document should be from, as a code; a mismatch is a warning code.

Pattern: ^[A-Za-z]{2,3}$
expectedFirstName
string

First name to check against the name on the document.

Required string length: 1 - 128
expectedLastName
string

Last name to check against the name on the document.

Required string length: 1 - 128
maxAgeMonths
object

How old the document may be per kind, in months. Leave out for no age limit.

saveRecord
boolean

False (default): nothing is kept — the document is processed for this one answer and not stored. True: the check is kept as a retrievable verification record (its data and document stay until deleted, and you get a ref for the follow-up calls).

endUserId
string

Your own stable id for the person (an opaque id, never a name or an email). It is sent to the verification service with the check, also when nothing is saved: the service uses it to tie the check to their other records.

Maximum string length: 256

Response

The result

status
string
required

passed when the document proved the address with no declining warning; failed otherwise.

documentType
string
required

Kind of proof-of-address document: utility_bill, bank_statement, government_issued, other, or unknown.

warnings
string[]
required

Warning codes explaining a failed or flagged check (for example ADDRESS_MISMATCH_WITH_PROVIDED, POA_COUNTRY_MISMATCH_WITH_PROVIDED, INVALID_DOCUMENT_TYPE), empty when it passed cleanly.

documentSubtype
string

Finer kind, for example ELECTRICITY_BILL or ACCOUNT_STATEMENT.

issuer
string

Company or authority that issued the document.

issueDate
string

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

documentExpiry
string

When the document expires, YYYY-MM-DD, when it carries one.

issuingCountry
string

Country that issued the document, as a code.

nameOnDocument
string

The person's name as printed on the document.

addressLine
string

The address as printed on the document, as one line.

ref
string

Reference to what this call created. Pass it as ref to identity.verification.get or identity.verification.delete (only set when saveRecord was true).