If you need an Entity to repeat their ID Document checks on a Process which they have completed, this can be done via the following endpoint: POST /api/v2/ci/processes/{processId}/reinvite-idv
You will need to provide the processId of the Process that you wish the ID document checks to be repeated for.
The request body needs to be structured as follows:
{
"actors": [
{
"actorId": 0,
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"saveContactDetails": true,
"emailAddress": "string",
"diallingCodeId": 0,
"phoneNumber": "string",
"firstName": "string",
"surname": "string",
"contactType": 0,
"resubmitIdvDocumentSection": 1
}
]
}
actorID
This identifies the role on the Process that the Entity performed. This is NOT the ActorID that is associated with the Journey template. This will be returned when you create the Process (or via the GET /processes/{processId}/details endpoint), and can be located in the ProcessActors section.
saveContactDetails
This determines whether the contact details used in this API call are persisted on the Entity.
resubmitIdvDocumentSection
This specifies which ID document elements need to be resubmitted: (1=All documents, 2=Biometric Documents only, 3=Non-Biometric Documents only)
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
Join our live training sessions
Whether you're new to Credas or simply looking for a refresher, we’ve got you covered! We now offer regular training sessions designed to help you get the most out of the Credas platform. These sessions are tailored to different product areas, including: - AML / ID verification - Right to Work - Our brand-new Credas Lettings solution - Admin / advanced training In each session we will walk you through how platform works and answer any questions you may have.
See our full training schedule