Skip to main content
POST
identity.verification.retry

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
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})$
actions
string[]
required

Installed action labels to repeat.

Required array length: 1 - 20 elements

Your label for this item.

Pattern: ^[a-z][a-z0-9_-]{0,63}$
reason
string
required

Reason for repeating these checks.

Required string length: 1 - 500
checkUnits
integer

Approved total check units for these actions. Defaults to one per action and must match the installed workflow.

Required range: 1 <= x <= 20
notify
boolean
default:true

Notify the person about the repeated checks.

Response

The result

status
string
required

The retry was accepted; checks are not complete.

Allowed value: "accepted"