...
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
The following information defines the API call developed solely for Duferco so that we can to identify and register users in our QERDS service without sending the need to send a first communication, that is, Duferco asks us . Customer requests through the API call to that we initiate a registration process of a user with some mandatory data (name, surname and email) in the QERDS qualified notifications service, once registered in the service, Duferco the customer may either send through the general API (EviNoticeSubmit) or the web portal send certified communications to this that user. |
Request Method : PUT
Request URL : https://verifid.ecertia.com/api/v1/Enrollments
Authentication :
This API requires via an API key. They key must be included in the request header.
Request Headers
Header Name | Value | Description |
---|---|---|
X-VerifiD-ApiToken | your_api_key_here | The API key for authenticating the request |
Request Body
List of Parameters
Field | Type | Description | Example |
---|---|---|---|
Profile | string | Required profile to identify how to enroll the user | Bit4Id::SPIDOnly::DufercoCustomer |
Language | string | Language preference for UI and documents to be generated on enrollment. Typically uses ISO 639-1 codes. | it |
string | The email address of the user. Must be a valid email format. | ||
FirstName | string | The first name of the user. | John |
LastName | string | The last name of the user. | Doe |
ReturnUrl | string | The URL to which the user will be redirected after enrollment. Must be a valid URL. |
Panel | ||
---|---|---|
| ||
{ } |
Request Response
...
Status 200 OK
Panel | ||
---|---|---|
| ||
{ "Consumer": "Customer", |
Response Schema
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://dufercocustomer.com/{dufercoIdcustomerid}/enroll |
Status
...
Panel | ||
---|---|---|
| ||
{ "Consumer": "duferco", |
...
401 Unauthorized
Panel | ||
---|---|---|
| ||
{ |
Status 400 Bad Request
Panel | ||
---|---|---|
| ||
{ |
Status 503 Service Unavailable
Panel | ||
---|---|---|
| ||
{ |
Return URL
https://{returnUrl}?{verifIdResult=}&{verifIdError=}
QueryString ParamsValues:
- 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 |
...