Start Grant Link Flow | Welcome to cash-app Documentation

Initiates the headless grant link flow process.

AuthorizationBasic

Basic authentication of the form Basic <base64(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

expiresAtdatetime

When this link attempt will expire

deliveryTypeenum

How the verification code was delivered to the consumer

404

Not Found Error

412

Precondition Failed Error

429

Too Many Requests Error

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

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