Skip to main content
POST
/
onboards
Create a new onboard
curl --request POST \
  --url https://app.leadconduit.com/onboards \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invitation_id": "64b8f0f5e4b0c3a1d5e6f7a8"
}
'
{
  "invitation_id": "64b8f0f5e4b0c3a1d5e6f7a9",
  "id": "5fd4371e940df5a34a3888b2",
  "account_id": "64b8f0f5e4b0c3a1d5e6f7a8",
  "connection_id": "64b8f0f5e4b0c3a1d5e6f7aa",
  "flow_id": "64b8f0f5e4b0c3a1d5e6f7ab",
  "status": "created",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

LeadConduit uses HTTP Basic Authentication with the username API and your API key as the password.

For example: API:1f1b96c9150d8050e858c043d543bb4eadae0e6f'

Body

application/json

Create a new onboard

Request body for creating a new onboard

​
invitation_id
string
required

The invitation ID to create the onboard from

Pattern: ^[0-9a-fA-F]{24}$
Example:

"64b8f0f5e4b0c3a1d5e6f7a8"

​
flow_id
string

Optional. The flow ID to use for the onboard if the UI already has it

Pattern: ^[0-9a-fA-F]{24}$
Example:

"64b8f0f5e4b0c3a1d5e6f7ab"

Response

Created

An onboard record tracks the onboarding process for a buyer connection

​
invitation_id
string
required

The invitation ID associated with this onboard

Pattern: ^[0-9a-fA-F]{24}$
Example:

"64b8f0f5e4b0c3a1d5e6f7a9"

​
id
string

24 character alpha-numeric BSON identifier

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5fd4371e940df5a34a3888b2"

​
account_id
string

The account ID that owns this onboard

Pattern: ^[0-9a-fA-F]{24}$
Example:

"64b8f0f5e4b0c3a1d5e6f7a8"

​
connection_id
string

The connection ID used for the onboard (retrieved from the invitation)

Pattern: ^[0-9a-fA-F]{24}$
Example:

"64b8f0f5e4b0c3a1d5e6f7aa"

​
flow_id
string

The flow ID to be used for the onboard (normally the minimal flow)

Pattern: ^[0-9a-fA-F]{24}$
Example:

"64b8f0f5e4b0c3a1d5e6f7ab"

​
status
string

Current status of the onboard process, recommended values are: created, in_progress, completed

Example:

"created"

​
created_at
string<date-time>

Timestamp when the onboard was created

​
updated_at
string<date-time>

Timestamp when the onboard was last updated