...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
The following information defines the API call developed solely for Duferco so that we can identify and register users in our QERDS service without sending a first communication, that is, Duferco asks us through the API call to 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 may either through the general API (EviNoticeSubmit) or the web portal send certified communications to this user. |
Request Method >> PUT
Request URL >> https://verifid.ecertia.com/api/v1/Enrollments
...
| 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 | string | URL to which the user will be redirected after enrollment. | I.e. https://duferco.com/{dufercoId}/enroll QueryString Params: |
| Panel | ||
|---|---|---|
| ||
{ "Consumer": "duferco", |
...