...
Field | Type | Description | Example |
---|---|---|---|
Id | string | Unique identifier for the enrollment | 018fa01b-1c42-4588-90da-dcaa52a8a236 |
Kinds | array | Types of communication channels added on the enrollment (Email, Phone). | ["Email"] |
State | string | Current state of the enrollment process. | New |
Outcome | string | Outcome of the enrollment process, if available. | null |
Name | string | First name of the user. | John |
LastName | string | Last name of the user. | Doe |
DocumentNumber | string | Document number associated with the user, if available. | null |
string | Email address of the user. | ||
Phone | string | Phone number of the user, if available. | null |
Language | string | Language preference of the enrollment process | it |
Provider | string | Identity provider that will validate the enrollment. | bit4id |
IdentificationUrl | string | Identification Provider URL to start the identification, if available. | null |
EnrollUrl | string | Landing URL for starting the enrollment process. | https://verifid.ecertia.com/enrollment/start/018fa01b-1c42-4588-90da-dcaa52a8a236 |
ReturnUrl more info at the bottom | string | URL to which the user will be redirected after enrollment. | I.e. https://duferco.com/{dufercoId}/enroll |
Status 200 OK
Panel | ||
---|---|---|
| ||
{ "Consumer": "duferco", |
Status 401 Unauthorized
Panel | ||
---|---|---|
| ||
{ |
Status 400 Bad Request
Panel | ||
---|---|---|
| ||
{ |
Status 503 Service Unavailable
Panel | ||
---|---|---|
| ||
{ |
Return URL
https://{returnUrl}?{verifIdResult}{verifIdError}
...
- verifidResult (string) : success | error
- verifidError (string) : errorcode
...
verifidError Codes
Code | Description | ||
---|---|---|---|
NotSupportedDocument | Identity Document provided during validation is not supported | ||
RequestAlteredInfo | Provided verification info as been altered during OnBoarding process | ||
RequestIsExpired | Current request is expired | ||
RequestInvalidInfo | Enrollment request data is not correct | ||
UnexpectedFailure | Unexpected failure while processing the Enrollment | ||
OnBoardingProviderError | Problems occured with Onboarding Provider | ||
PdfValidationError | Pdf Certificate validation has failed |
...