Start Grant Link Flow

Initiates the headless grant link flow process.

AuthorizationBasic

Basic authentication of the form Basic <username:password>.

This endpoint expects an object.

aliasstringRequired

Email or phone number associated with the consumer's account

requestIdstringRequired

A unique identifier for this request

Created

tokenstring

Token identifying the grant to be created

requestIdstring

The unique identifier from the request

expiresAtstringformat: "date-time"

When this link attempt will expire

deliveryTypeenum

How the verification code was delivered to the consumer

Allowed values:

1	curl -X POST https://global-api-sandbox.afterpay.com/v2/grants/start \
2	-H "Content-Type: application/json" \
3	-u "<username>:<password>" \
4	-d '{
5	"alias": "my-afterpay-email@gmail.com",
6	"requestId": "123e4567-e89b-12d3-a456-426614174000"
7	}'

1	{
2	"token": "005.2fkv5o963b132z8ppa34srlh60987y87d55re237wsg9tr4q2",
3	"requestId": "123e4567-e89b-12d3-a456-426614174000",
4	"expiresAt": "2025-03-22T12:00:00Z",
5	"deliveryType": "SMS"
6	}