Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Auth

Create a pushed authorisation request

post/par

Request body

client_idstring required

Your App ID Token

client_secretstring required

Your App Secret

redirect_uristring uri required

The redirect URI to use when redirecting the user back to your application.

redirect_mode'default' | 'embedded' | 'deep_link'

The mode of redirect to use when redirecting the user back to your application.

response_type'code' required

The response type to use for this request, only 'code' is supported.

statestring

Any request state that should be passed back to your application when redirecting.

correlation_idstring

Example request

{
  "client_id": "app_token_c01234567890123456789012345",
  "login_hint": "user_c01234567890123456789012345",
  "request": {
    "connections": [
      "conn_cjgaac5at000001qi2yw8ftil"
    ],
    "constraints": {
      "payments": {
        "payees": [
          {
            "account_number": "12-3456-7890123-00"
          }
        ]
      }
    }
  }
}

Response

Success

successtrue required
request_uristring required

The pushed authorisation request_uri that should be specified in the authorisation URL.

authorisation_urlstring uri required

A pre-built authorisation URL that the user can be redirected to for authorisation, this includes the request_uri and any other necessary query parameters.

expires_innumber required

The number of seconds until the request URI expires.