You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 16
Next »
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
Authentication >> This API requires via an API key. They key must be included in the request header.
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 |
Email | string | The email address of the user. Must be a valid email format. | j.doe@namirial.com |
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/{id}/enroll |
{
"Profile": "Bit4Id::SPIDOnly::Duferco",
"Language": "it",
"Email": "j.doe@namirial.com",
"FirstName": "John",
"LastName": "Doe",
"ReturnUrl": "https://duferco.com/enroll/"
}
Request Response
List of parameters
{
"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",
"Consumer": "duferco",
"IdentificationUrl": null,
"EnrollUrl": "https://verifid.ecertia.com/enrollment/start/018fa01b-1c42-4588-90da-dcaa52a8a236",
"ReturnUrl": "https://duferco.com"
}