Skip to Content

Create a claim link

POST
/api/agent/signup

With the person's permission, create a signup handoff. No tokens or email are issued. The person signs in with the supplied email, accepts terms and enters a card. Claims expire after 24 hours with 5 failed attempts. Signup limits: 20/IP/hour and 3/email/hour. Email is trimmed and lowercased; locally blocked temporary domains are rejected. Body limit: 4,096 bytes.

Request Body

application/json
  1. body
email*string
Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
Lengthlength <= 254
plan?string
Default"ink"
Value in"ink""ink_pro"
interval?string
Default"monthly"
Value in"monthly""annual"
agent?

Response Body

Claim handoff. Existing and new emails receive the same shape.

application/json
  1. response
claim_code*string
claim_url*string
Formaturi
expires_at*string
Formatdate-time
next_steps*string
Example Request
curl -X POST 'https://ink.ego.ist/api/agent/signup' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "user@example.com"
}'
Example Response
{
  "claim_code": "string",
  "claim_url": "http://example.com",
  "expires_at": "2019-08-24T14:15:22Z",
  "next_steps": "string"
}