---
title: "Create a Connect URL"
method: POST
path: "/"
---

# Create a Connect URL

`POST /`

## Request

- Base URL: `https://api.tap.company/v3/connect`
- URL: `https://api.tap.company/v3/connect/`
- Auth: none required

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

## Request body

- object
  - `scope` string, required: Authenticating the lead created and converting it to an account if all validation rules are met
  - `data` string[]: Array of data to be sent by connect after account creation to the post url: "operation" , "brand" , "entity" , "merchant"
  - `lead` object, required: Contains information about the lead
    - `id` string: Lead ID created for the merchant using the lead API.
  - `board` object: Configuration settings related to the display and editability of interface
    - `editable` boolean: Enable the modification of the already added information from the lead
    - `display` boolean: Show/Hide the board details after completing the connect flow. Board will contains the below information: Brand info-Entity “License” info-Individual “users” info-Tax “if any‘ info-Bank info
  - `redirect` object, required: Redirection page following the account creation & board
    - `url` string, required: Redirection page following the account creation & board
  - `post` object, required: URL where the webhook is set up.
    - `url` string: URL for the merchant's post endpoint
  - `webhook` object: URL where the webhook is set up.
    - `url` string: Endpoint to push the operator details if wasn't sent previously on the post url
  - `interface` object: Configuration settings for customizing the appearance and behavior of the interface
    - `direction` string: Defines the text direction for the Connect Interface
    - `locale` string: Specifies the language to be used in the Connect Interface
    - `edges` string: Determines the style of the interface edges in the Connect Interface. Values available: curved-straight

## Response `200`

200

- object
  - `id` string
  - `created` integer
  - `api_version` string
  - `token` string
  - `operator` object
    - `public_key` string
  - `scope` string
  - `data` string[]
  - `lead` object
    - `id` string
  - `board` object
    - `display` boolean
    - `editable` boolean
  - `interface` object
    - `locale` string
    - `direction` string
    - `edges` string
  - `connect` object
    - `url` string
  - `redirect` object
    - `url` string
  - `post` object
    - `url` string
  - `lead_id` string
  - `public_key` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/tap/apis/connect.md) - [All operations](https://skmtc.dev/tap/apis/connect/llms.txt) - [OpenAPI document](https://skmtc.dev/tap/apis/connect/revisions/b091b19cf543?raw)