requisitions

GET /api/v2/requisitions/{id}/

Retrieve a requisition by ID

Request

idstring uuid required

A UUID string identifying this requisition.

Get requisition by ID

idstring uuid

createdstring date-time nullable

The date & time at which the requisition was created.

redirectstring uri nullable required

redirect URL to your application after end-user authorization with ASPSP

status'CR' | 'ID' | 'LN' | 'RJ' | 'ER' | 'SU' | 'EX' | 'GC' | 'UA' | 'GA' | 'SA'

institution_idstring required

an Institution ID for this Requisition

agreementstring uuid

EUA associated with this requisition

referencestring

additional ID to identify the end user

accountsstring[]

array of account IDs retrieved within a scope of this requisition

user_languagestring

A two-letter country code (ISO 639-1)

linkstring uri

link to initiate authorization with Institution

ssnstring

optional SSN field to verify ownership of the account

account_selectionboolean

option to enable account selection view for the end user

redirect_immediateboolean

enable redirect back to the client after account list received

No recorded changes to this operation across all 1 revision of this API.