Skip to main content
POST
identity.verification.media.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-configured.

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

Your label for this item.

Pattern: ^[a-z][a-z0-9_-]{0,63}$
selection
enum<string>
default:primary

Primary or secondary action media, or one selected linked document.

Available options:
primary,
secondary,
document
documentType
enum<string>

Linked document type; required for document selection.

Available options:
national_id,
tax_id,
driving_licence,
vehicle_registration,
school_year_10,
school_year_12,
ration_card
format
enum<string>
default:binary

Original media bytes or national identifier XML up to 1 MB.

Available options:
binary,
xml

Response

The result

file
object
required

Selected verification media copied to private storage.