Integration Guides
Create a profile via API
overview customers often need to create a profile from their own systems the following provides a guided flow to the user to create the profile that reacts based on the type of profile get a list of the available profile types from detected capture the required type and the relevant country from the customer if a search is available for the profile type then gather the inputs and perform the search if search is not available surface the required inputs to the customer create the profile \ config theme redux dark look classic \ sequencediagram participant clientfrontend as clients frontend 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 get required inputs clientbackend >> detectedapis get /search/types detectedapis >> clientfrontend profile types note left of clientfrontend show entity types & \<br/>country list to user clientfrontend >> clientbackend user selects country and profile type alt note over clientfrontend, detectedapis if search required for selected type clientbackend >> detectedapis get /search/types/{type}/{countrycode} detectedapis >> clientfrontend required fields for search form note left of clientfrontend build search form \<br/>for user to complete clientfrontend >> clientbackend user submits search form clientbackend >> detectedapis post /search detectedapis >> clientfrontend search results note left of clientfrontend show search results to user alt note over clientfrontend, detectedapis if user selects a match clientfrontend >> clientbackend user selects result from search clientbackend >> detectedapis post /profiles (using lookup id & response id) note right of detectedapis profile created else note over clientfrontend, detectedapis if no results or no match not selected clientfrontend >> clientbackend user selects no match clientbackend >> detectedapis get /profile/types/{type}/{countrycode} detectedapis >> clientfrontend required fields for manual create form note left of clientfrontend build manual create form \<br/>for user to complete clientfrontend >> clientbackend user submits manual create form clientbackend >> detectedapis post /profiles note right of detectedapis profile created end else note over clientfrontend, detectedapis if search not required for type clientbackend >> detectedapis get /profile/types/{type}/{countrycode} detectedapis >> clientfrontend required fields for manual create form note left of clientfrontend build manual create form \<br/>for user to complete clientfrontend >> clientbackend user submits manual create form clientbackend >> detectedapis post /profiles note right of detectedapis profile created end