Skip to main content
curl --request POST \
  --url https://api.yapily.com/pre-auth-requests \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "applicationUserId": "string",
  "institutionId": "n26",
  "callback": "https://display-parameters.com/",
  "scope": "AIS"
}
'
{
  "meta": {
    "tracingId": "8acb66e6a9e142e79acc3ccf6cc03e04"
  },
  "data": {
    "id": "73064bb9-c84d-4242-897c-4150aacfa658",
    "userUuid": "e2578545-27a4-4edf-983f-5d33c2d7b559",
    "applicationUserId": "string",
    "institutionId": "n26",
    "state": "1575102ed5664761bce34927f0caa50f",
    "status": "AWAITING_PRE_AUTHORIZATION",
    "createdAt": "2021-05-11T13:03:43.619Z",
    "featureScope": [
      "INITIATE_PRE_AUTHORISATION"
    ],
    "authorisationUrl": "https://app.n26.com/open-banking?requestId=9ae856ce-6b10-4956-8da8-c66ee0c9d86f&state=1575102ed5664761bce34927f0caa50f&authType=XS2A&scope=DEDICATED_AISP",
    "qrCodeUrl": "https://images.yapily.com/image/f86d382b-c00a-4650-8d0d-9ee6ba1093cd/1620738225?size=0"
  }
}
Learn more: Pre-Authorisation Flow

Authorizations

​
Authorization
string
header
required

Use HTTP Basic Authentication with your Application ID as username and Application Secret as password. Manage credentials in the Yapily Console. See Authentication for details.

Headers

​
psu-id
string

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-id
string

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-address
string

Conditional. The IP address of the PSU.

See PSU identifiers to see if this header is required.

​
sub-application
string<uuid>

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

Query Parameters

​
raw
boolean

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

Body

application/json;charset=UTF-8
​
institutionId
string
required

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

Example:

"yapily-mock"

​
scope
string
required

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

Example:

"AIS"

​
userUuid
string<uuid>
​
applicationUserId
string

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.

Example:

"user-234562290"

​
forwardParameters
string[]

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

​
callback
string

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.

Example:

"https://display-parameters.com"

​
redirect
object

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

​
oneTimeToken
boolean

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.

Example:

false

Response

Created

​
meta
object
​
data
object
​
links
object
​
forwardedData
object[]
​
raw
object[]
deprecated