API by router
Onboarding internal
GET
instance_id*Instance IdFormat
uuidperson_id*Person IdFormat
uuidSuccessful Response
application/json- response
eligible*Eligiblereason?string|nullcurl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboarding/check-eligible?person_id=497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "eligible": true, "reason": "string"}POST
instance_id*Instance IdFormat
uuidapplication/json- body
customer_id*Customer IdFormat
uuidflow_id*Flow IdFormat
uuidinitiated_via?Initiated ViaDefault
"agent"person_id?|nullSuccessful Response
application/json- response
completed_at*|nullcreated_at*Created AtFormat
date-timecurrent_stage*string|nullcustomer_id*Customer IdFormat
uuidflow_id*Flow IdFormat
uuidid*IdFormat
uuidperson_id*|nullrefresh_schedule_id*|nullstage_statuses*started_at*|nullstatus*Statuscurl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboarding/initiate' \ -H 'Content-Type: application/json' \ -d '{ "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2"}'Example Response
{ "completed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "current_stage": "string", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "flow_id": "0746f03b-16cc-49fb-9833-df3713d407d2", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550", "refresh_schedule_id": "549f35cd-d5a1-4cb0-8daf-3b87f4ccbf3b", "stage_statuses": {}, "started_at": "2019-08-24T14:15:22Z", "status": "string"}POST
instance_id*Instance IdFormat
uuidonboarding_id*Onboarding IdFormat
uuidapplication/json- body
completed_stage_slug*Completed Stage Slugperson_id?|nullsubmission_id?|nullSuccessful Response
application/json- response
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboarding/497f6eca-6276-4993-bfeb-53cbbbba6f08/advance' \ -H 'Content-Type: application/json' \ -d '{ "completed_stage_slug": "string"}'Example Response
{}