An entity is the individual you are seeking to verify through Credas. Within the API entities are identifiable by their entityId.
To resend an invite an an entity you can send a PUT request to the /api/v2/ci/entities/{entityId}/resend-invite endpoint.
You can only use this request where an entity has already received an invite.
Request body
When sending your request to this endpoint you will must set the contact preferences:
{
"contactByEmail": true,
"contactBySms": true
}
These true / false values will determine the type of invite received by the entity.
Note: You cannot send an invite to via email or SMS if you have not provided Credas with the relevant contact information i.e. email address or phone number.
Response body
You will not receive a response body from this endpoint, if your request is successful you will receive a 200 http response.
If you receive a 400 response this typically indicates that the entity has not previously been invited so cannot be re-invited.
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