Skip to main content
POST
/
onboard
/
buyer
curl --request POST \
  --url https://app.leadconduit.com/onboard/buyer \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "invitation_id": "64b8f0f5e4b0c3a1d5e6f7a9",
  "flow_id": "64b8f0f5e4b0c3a1d5e6f7aa"
}
'
{
  "redirect": "/flows/64b8f0f5e4b0c3a1d5e6f7a8"
}

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

Buyer setup request

Request body for completing buyer onboarding setup. Either connection_id or invitation_id must be provided.

​
connection_id
string
required

The connection ID for the buyer setup

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

"64b8f0f5e4b0c3a1d5e6f7a8"

​
flow_id
string

Optional. The existing flow ID to use for buyer delivery

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

"64b8f0f5e4b0c3a1d5e6f7aa"

Response

OK - Buyer setup completed successfully

Response from the buyer onboarding endpoint

​
redirect
string

The URL path to redirect the user to after successful setup

Example:

"/flows/64b8f0f5e4b0c3a1d5e6f7a8"