Skip to main content
POST
document.wallet.document.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})$
documentType
string
required

Public national catalogue document code.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_-]+$
issuerId
string
required

Public national catalogue issuer code.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9_-]+$
parameters
object[]
required

Named parameters required by the issuer.

Maximum array length: 20
format
enum<string>
required

Document format.

Available options:
pdf,
xml

The person authorized this document read.

Response

The result

file
object
required

Copied document in your file storage.