A typical integration will involve the following sequence:
1. Create a Process and an Entity
POST /api/v2/ci/process
See the swagger definition for the full list of possible parameters. As a minimum (and typical) implementation, your request object should contain the following:
{
"journeyId": "9429d6b1-de6e-4fac-8343-9a48c4d5534f",
"title": "Example Process",
"processEntities": [
{
"emailAddress": "example@credas.com",
"firstName": "John",
"surname": "Smith",
"actorId": 110,
"contactViaEmail": true,
"contactViaSms": false,
"inPerson": false
}
]
}
This will create a Process based on the 'Identity' journey type (JourneyID: 9429d6b1-de6e-4fac-8343-9a48c4d5534f ), create an Entity with email address Example@credas.com and send an invite out to the entity via email. The Entity will be the role of 'Applicant' on the Process (actorId: 110).
The response that you receive from this endpoint will contain the processId (the second parameter in the response - "id") and also an entityId ("entityId" which is located in the "ProcessActors" section towards the end of the response).
The processId is a unique identifier which relates to the process instance which has been created; the entityId is a unique identifier which relates to the person you are interacted with. We recommend that you store both these values within your system as both will be needed to retrieve results later.
A list of your available journeys can be retrieved by the endpoint: GET /api/v2/ci/journeys. Please see the Retrieving your JourneyIds and ActorIDs page for more details
For reference, a list of all our public journeyIds and ActorIDs (including for AML, Right To Work, Safe Harbour etc.) can be found on our Public JourneyIds page.
2. The end user (Entity) completes their Process
The person you are interacting with will receive the email, which will contain a link to the Credas web app or native mobile app (depending how the journey has been configured).
They will follow the steps in the Process (as defined by the Journey type that the process was based on), which will guide them through scanning their ID document, entering any required input fields etc.
3. Webhook push notification issued by Credas
When the end user has completed all the steps in the journey we can send a push notification to a webhook.
Your webhook URL can either be added to your portal configuration (please ask your technical support / Implementation consultant to add this for you), or it can be specified when you create the Process in step 1.
To specify a webhook URL when you create the process, simply add the "webhookUrl" parameter immediately before the "processEntities" section as shown below:
{
"journeyId": "9429d6b1-de6e-4fac-8343-9a48c4d5534f",
"title": "Example Process",
"webhookUrl": "https://....",
"processEntities": [
{
"emailAddress": "example@credas.com",
"firstName": "Kevin",
"surname": "Smith",
"actorId": 110,
"contactViaEmail": true,
"contactViaSms": false,
"inPerson": false
}
]
}
The JSON in the Webhook response body will look like this:
{
"ProcessId": "xxx",
"ClientId": "xxx",
"Status": 2,
"StatusDescription": "The process is complete"
}
Status 2 = The process is complete.
4. Retrieve the results
There are a number of options for retrieving the results of a Process via the API. Please see our Retrieving results page for full details.
Typically, you might want to retrieve a summary of the checks that have been completed for the Entity, which can be done via: GET /api/v2/ci/entities/{entityId}/summary and/or retrieve a PDF export which can be done via: GET /api/v2/ci/entities/{entityId}/{processId}/pdf-export
5. Store the information you require
Finally you may wish to store the results in your own system - either the summary data and/or the PDF export.
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article