Skip to main content
POST
Create a capture link

Authorizations

Authorization
string
header
required

Your API key: gt_live_… or gt_test_…

Body

application/json
method
enum<string>
default:link
Available options:
link,
sms,
whatsapp
contact
string

Required for sms and whatsapp: international format, e.g. +254712345678.

language
enum<string>
default:en
Available options:
en,
sw
prefill
object

Filled in for the customer, who can't change it.

externalRef
string
Maximum string length: 100

Response

Created.

id
string
required
Example:

"cap_8Fq2kT0aZx91LmPw"

method
enum<string>
required
Available options:
link,
sms,
whatsapp
contact
string | null
required
language
enum<string>
required
Available options:
en,
sw
externalRef
string | null
required
status
enum<string>
required
Available options:
pending,
opened,
submitted,
expired,
cancelled
delivery
enum<string>
required
Available options:
not_sent,
pending,
sent,
failed
createdAt
number
required

Unix time in milliseconds.

expiresAt
number
required

Unix time in milliseconds.

deliveryFailure
string | null
openedAt
number | null
submittedAt
number | null
verificationId
string | null

The KYC check the submission became.

The customer's address. null with a test key.

sandbox
boolean