Flows
Create a flow
POST
/
api
/
flow
/
create
Authorization
Body
{
"steps": ["compliance"],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}
{
"success": true,
"flow": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"steps": ["compliance"],
"completed-steps": ["compliance"],
"payout-link-id": "d0cc26ba-2cf4-40ff-be89-1b949535e8e4",
"link": "string"
}
}
Authorizations
Authorizationheaderrequired
string
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
application/json
stepsrequired
enum<string>[]
Available options:
compliance
, manage-payments
, manage-payouts
, payout
user_id
string
Response
200 - application/json
flow
object
success
boolean
{
"steps": ["compliance"],
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}
{
"success": true,
"flow": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"created": "2019-08-24T14:15:22Z",
"updated": "2019-08-24T14:15:22Z",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"steps": ["compliance"],
"completed-steps": ["compliance"],
"payout-link-id": "d0cc26ba-2cf4-40ff-be89-1b949535e8e4",
"link": "string"
}
}