---
title: "Create a pushed authorisation request"
method: POST
path: "/par"
tags: ["Auth"]
---

# Create a pushed authorisation request

`POST /par`

## Request body

- object
  - `client_id` string, required — Your App ID Token
  - `client_secret` string, required — Your App Secret
  - `login_hint` union — A login hint to suggest a user to use for 'enduring_access' requests. This will be ignored for other request types. The user may choose to authenticate as a different Akahu user than specified. This may be in the form of an email address or an Akahu User ID.
    - string, email
    - string
  - `redirect_uri` string, 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.
  - `state` string — Any request state that should be passed back to your application when redirecting.
  - `correlation_id` string
  - `request` union, required
    - EnduringAccessRequest
      - `type` 'enduring_access', required
      - `connections` union — Which connections your application is requesting access to for this request. Defaults to connections enabled for your application.
        - ConnectionId[]
        - ConnectionStub[]
      - `scope` EnduringAccessScope[] — Which scopes your application is requesting access for this request. Defaults to all scopes enabled for your application. If the user already has a previous authorisation with less or more scopes, this will not trigger a replacement.
      - `constraints` EnduringAccessConstraints — Any constraints on this access request.
        - `transactions` TransactionConstraints — Any constraints on transaction data that should be included in this access request, uses app defaults if not specified.
          - `start_date` string, date, required — The start date for transactions to be requested from for new consents, this is in the Pacific/Auckland timezone.
        - `payments` EnduringAccessPaymentRequestApiView — The payment consent details for this request.
          - `single_limit` number, required — The single payment limit for payments initiated under this consent.
          - `periodic_limit` EnduringPaymentPeriodLimit, required — The periodic payment limit for payments initiated under this consent.
            - `amount` number, required — The amount that can be paid in the specified frequency period.
            - `frequency` 'DAILY' | 'WEEKLY' | 'FORTNIGHTLY' | 'MONTHLY' | 'ANNUALLY', required — The frequency at which the periodic limit applies, this is used in combination with the amount to determine the periodic limit. (E.g. $1 daily)
          - `payees` EnduringPayee[], required — The payees that are authorized to receive payments under this consent. At least one payee must be specified.
            - union
              - …
    - EnduringPaymentConsentRequest
      - `type` 'enduring_payment_consent', required
      - `_user` string, required
      - `_account` string, cuid, required — A unique identifier for the account in the Akahu system. It is always prefixed by `acc_` so that you can tell that it belongs to an account.
      - `payment_consent` EnduringPaymentConstraints — The payment consent details for this request.
        - `label` string — The label that groups these payment constraints. This is used to help distinguish between multiple payment consents for the same account. When re-consenting, this label will ensure that the old consent with the same label is replaced by the new one.
        - `single_limit` number, required — The single payment limit for payments initiated under this consent.
        - `periodic_limit` EnduringPaymentPeriodLimit, required — The periodic payment limit for payments initiated under this consent.
          - `amount` number, required — The amount that can be paid in the specified frequency period.
          - `frequency` 'DAILY' | 'WEEKLY' | 'FORTNIGHTLY' | 'MONTHLY' | 'ANNUALLY', required — The frequency at which the periodic limit applies, this is used in combination with the amount to determine the periodic limit. (E.g. $1 daily)
        - `payees` EnduringPayee[], required — The payees that are authorized to receive payments under this consent, at least one payee must be specified.
          - union
            - PaymentConsentStaticPayeeInput
              - …
            - PaymentConsentRegisteredPayeeInput
              - …
            - union
              - …

## Response `201`

Success

- AuthorisationRequestSuccessResponse
  - `success` true, required
  - `request_uri` string, required — The pushed authorisation request_uri that should be specified in the authorisation URL.
  - `authorisation_url` string, 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_in` number, required — The number of seconds until the request URI expires.

## Other responses

- `400` — Invalid request
- `401` — Unauthorized
- `415` — Unsupported media type
- `500` — Internal server error

---

[API](https://skmtc.dev/akahu/apis/akahu-enduring-api.md) · [All operations](https://skmtc.dev/akahu/apis/akahu-enduring-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/akahu/akahu-enduring-api/revisions/b2de9915920d/schema)