Skip to main content
The values each enumerated field on a request for information takes.

status

Where the request itself is. Only the last two are endings.

resolution_reason

Why a request closed unsatisfied. null on any request that has not.

item status

Where one item is. An item has no closed states of its own. The request carries those.

answer_type

What an item is asking for, and therefore what a valid answer looks like. answer_spec on the item carries the rules for that type.
New answer types can be added. Read one you do not recognise as an item your customer cannot answer through the API, and show its prompt.

answer_spec by answer type

The item carries an answer_spec holding the rules its answer is validated against. The answer_type fixes which keys it holds.

document_type

Present on a document item only when a specific document is asked for. Render it as what to send. It takes the same values as a document you supply yourself. User values lists them and what each is for. Tell them apart by which keys are present:
A link you create works for 30 days, until its expires_at. Create it when someone needs it rather than when the page renders, and create a new one once expires_at has passed. The same holds for a signature_link and a fatca_questions item.

The named formats

Used by format on a text or identifier item. A new named format is data on the item, not a change to this contract.

blocking type

What the request is anchored to. null when it is about the sub-client itself rather than one movement or one capability request. There is no virtual-account anchor. A request never names which account is blocked. New values can be added, so read one you do not recognise as about something other than the sub-client itself. A request anchored to a movement asks only for an explanation or a document. Every item on it has target_key of null, and none is a ubo_link, a signature_link or a fatca_questions. A request anchored to a capability request can carry a target_key naming a field of the sub-client, or a question of that capability’s form. None of its items is a ubo_link. Beneficial owners are asked about only on a request whose blocking is null.