Skip to main content
POST
Create a connected account

Authorizations

X-API-Key
string
header
required

Body

application/json
role
enum<string>
required
Available options:
seller,
buyer
entityType
enum<string>
required
Available options:
individual,
business
externalId
string
Required string length: 1 - 200
email
string<email>
Required string length: 1 - 200
displayName
string
Required string length: 1 - 200
country
string
Required string length: 2
taxId
string
Required string length: 1 - 64
metadata
object

Response

201 - application/json

Connected account created

id
string
required
orgId
string
required
role
enum<string>
required
Available options:
seller,
buyer,
self
entityType
enum<string>
required
Available options:
individual,
business
externalId
string | null
required
email
string | null
required
displayName
string | null
required
country
string | null
required
receiverId
string | null
required
status
enum<string>
required
Available options:
created,
verifying,
approved,
rejected
hostedFlowUrl
string | null
required
tosAccepted
boolean
required
payoutConfigured
boolean
required
payoutPending
boolean
required
submitPending
boolean
required
readyToCollect
boolean
required
submittedAt
string | null
required
approvedAt
string | null
required
rejectedAt
string | null
required
createdAt
string
required
updatedAt
string
required