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::Duferco |
| 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. | https://duferco.com/enroll |
Example of request in JSON
{
"Profile": "Bit4Id::SPIDOnly::Duferco",
"Language": "it",
"Email": "correo@dominio.com",
"FirstName": "Dani",
"LastName": "Crespo",
"ReturnUrl": "https://duferco.com/enroll/"
}
Request Response
List of parameters
| 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. |
Example of response in JSON
{
"Id": "018fa01b-1c42-4588-90da-dcaa52a8a236",
"Kinds": [
"Email"
],
"State": "New",
"Outcome": null,
"Name": "John",
"LastName": "Doe",
"DocumentNumber": null,
"Email": "j.doe@namirial.com",
"Phone": null,
"Language": "it",
"Provider": "bit4id",
"IdentificationUrl": null,
"EnrollUrl": "https://verifid.ecertia.com/enrollment/start/018fa01b-1c42-4588-90da-dcaa52a8a236",
"ReturnUrl": "https://duferco.com"
}