Skip to main content
POST
document.wallet.national-id.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 document.wallet.connect.

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

Personal fields to include; omitted fields stay private.

Maximum array length: 5

Fields you choose to receive.

Available options:
identity,
address,
photo,
xml,
fullIdentifier

Response

The result

status
enum<string>
required

Current flow state.

Available options:
pending,
complete,
failed,
expired,
revoked,
authenticated,
unauthenticated
maskedNumber
string

Masked national identifier, with at most four visible digits.

Required string length: 1 - 512
name
string

Name from the identity record.

Required string length: 1 - 512
gender
string

Recorded gender.

Required string length: 1 - 512
birthDate
string<date>

Date of birth when the complete date is known.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
birthYear
integer

Birth year when only the year is known.

Required range: 1800 <= x <= 2200
address
object

Address read from the document.

fullIdentifier
string

Full identifier, only when explicitly requested.

Required string length: 1 - 512
signatureVerified
boolean

Whether the document signature was verified.

generatedAt
string<date-time>

Date and time including its UTC offset.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
photo
object

Photo copied to your file storage.

xml
object

XML copied to your file storage.