YAyapily
Authorisations

Create Pre-authorisation

Used to initiate the pre-authorisation process for any Institution that contains the INITIATE_PRE_AUTHORISATION feature to authenticate the user.

Feature: INITIATE_PRE_AUTHORISATION

post/pre-auth-requests

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Query parameters

rawboolean

Optional. Used to obtain the raw request and response to and from the Institution.

Headers

psu-idstring

Conditional. Represents the user's login ID for the Institution to a personal account.

See PSU identifiers to see if this header is required.

psu-corporate-idstring

Conditional. Represents the user's login ID for the Institution to a business account.

See PSU identifiers to see if this header is required.

psu-ip-addressstring

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

sub-applicationstring uuid

The sub-application ID to which event type is being subscribed to

Request body

userUuidstring uuid
applicationUserIdstring

Conditional. The user-friendly reference to the User that will authorise the authorisation request. If a User with the specified applicationUserId exists, it will be used otherwise, a new User with the specified applicationUserId will be created and used. Either the userUuid or applicationUserId must be provided.

forwardParametersstring[]

Extra parameters to be forwarded in the redirect back to the client after the user authorisation flow has been completed.

institutionIdstring required

Mandatory. The reference to the Institution which identifies which institution the authorisation request is sent to.

callbackstring

Optional. The server to redirect the user to after the user complete the authorisation at the Institution.

See Using a callback (Optional) for more information.

oneTimeTokenboolean

Conditional. Used to receive a oneTimeToken rather than a consentToken at the callback for additional security. This can only be used when the callback is set.

See Using a callback with an OTT (Optional) for more information.

scopestring required

Mandatory. Defines the scope of the pre-authorisation request.

Example request

{
  "applicationUserId": "user-234562290",
  "institutionId": "yapily-mock",
  "callback": "https://display-parameters.com",
  "scope": "AIS"
}

Response

Created

linksobject
tracingIdstring

Changes

No recorded changes to this operation across all 4 revisions of this API.