Sign in

v1

latestOpenAPI 3.1.02026-07-2419077.8 KB

Create a Connect URL

This endpoint converts a lead into a connect URL which the merchant can complete the onboarding process.

post/

Request body

scopestring required

Authenticating the lead created and converting it to an account if all validation rules are met

datastring[]

Array of data to be sent by connect after account creation to the post url: "operation" , "brand" , "entity" , "merchant"

Response

200

idstring
createdinteger
api_versionstring
tokenstring
scopestring
datastring[]
lead_idstring
public_keystring

Example response

{
  "id": "connect_xxxx",
  "created": 1722856025033,
  "api_version": "v3",
  "token": "xxxx",
  "operator": {
    "public_key": "pk_test_xxxx"
  },
  "scope": "auth",
  "data": [
    "operator"
  ],
  "lead": {
    "id": "led_xxxx"
  },
  "board": {
    "display": true,
    "editable": true
  },
  "interface": {
    "locale": "en",
    "direction": "ltr",
    "edges": "curved"
  },
  "connect": {
    "url": "https://url-shortner.dev.tap.company/xxxx"
  },
  "redirect": {
    "url": "https://example.com/redirectUrl"
  },
  "post": {
    "url": "https://example.com/postUrl"
  },
  "lead_id": "led_xxxx",
  "public_key": "pk_test_xxxx"
}
All 19 operations