APIs
...
Integration Use Cases Guides
Trigger a KYB journey with redirect
overview this is a common flow for triggering a kyb flow from an external system, the clients system will gather basic information on the company, push that data to detected and then launch the onboarding journey powered by the detected portal the api flow is get search results based on a users search for a company after showing those back to the user send the selected company to detected create the user as a 'profile user' in detected assign that profile user to the profile get the pre authed link to the profile for that user redirect the user to that link or surface in an iframe listen for the webhook to confirm the profile has been submitted \ config theme redux dark look classic \ sequencediagram participant clientbackend as clients backend participant detectedapis as detected apis note over clientbackend, detectedapis authorisation clientbackend >> detectedapis post /oauth/token detectedapis >> clientbackend auth token note over clientbackend, detectedapis add company using search clientbackend >> detectedapis post /search detectedapis >> clientbackend search results clientbackend >> detectedapis post /profiles detectedapis >> clientbackend profile references note over clientbackend, detectedapis add profile user & assign to profile clientbackend >> detectedapis post /portal users detectedapis >> clientbackend portal user references clientbackend >> detectedapis put /profiles/{uuid}/portal users detectedapis >> clientbackend success note over clientbackend, detectedapis get authed link to redirect user clientbackend >> detectedapis post /portal users/{userid}/login links detectedapis >> clientbackend pre authed link for this user to access this profile note left of clientbackend surface this in an iframe or redirect the user note over clientbackend, detectedapis listen for webhook for when the onboarding is submitted detectedapis >> clientbackend profile webhook