Start Grant Link Flow

Initiates the headless grant link flow process.

post/v2/grants/start

Request

  • Base URL: https://global-api-sandbox.afterpay.com
  • URL: https://global-api-sandbox.afterpay.com/v2/grants/start
  • Auth: HTTP basic

Headers

Acceptstring

Request body

aliasstring required

Email or phone number associated with the consumer's account

requestIdstring required

A unique identifier for this request

Response

Created

tokenstring required

Token identifying the grant to be created

requestIdstring required

The unique identifier from the request

expiresAtstring date-time required

When this link attempt will expire

deliveryType'SMS' | 'EMAIL' required

How the verification code was delivered to the consumer

Changes

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