Versions Compared

Old Version 23

changes.mady.by.user Daniel Crespo Garcia

Saved on

compared with

New Version Current

changes.mady.by.user Daniel Crespo Garcia

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
titleColorwhite
titleBGColor#ccc
borderStyledashed
titleDefinition

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 send  through the general API (EviNoticeSubmit) or the web portal send portal  certified communications to this user. 

...

Panel
titleExample of request in JSON

{
        "Profile": "Bit4Id::SPIDOnly::Duferco",
        "Language": "it",
        "Email": "j.doe@namirial.com",
        "FirstName": "John",
        "LastName": "Doe",
        "ReturnUrl": "https://duferco.com/{id}/enroll/" 

}

Request Response

...

Status 200 OK

Panel
titleExample 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",

        "Consumer": "duferco",
        "IdentificationUrl": null,
        "EnrollUrl": "https://verifid.ecertia.com/enrollment/start/018fa01b-1c42-4588-90da-dcaa52a8a236",
        "ReturnUrl": "https://duferco.com/a9474480-ffbe-4382-b2f0-9a7d7592fec2/enroll"
}

Response Schema 

FieldTypeDescriptionExample
IdstringUnique identifier for the enrollment018fa01b-1c42-4588-90da-dcaa52a8a236
Kindsarray

Types of communication channels added on the enrollment (Email, Phone).

["Email"]
Statestring

Current state of the enrollment process.

New

Outcome

string

Outcome of the enrollment process, if available.

null
Namestring

First name of the user.

John

LastNamestring

Last name of the user.

Doe

DocumentNumberstring

Document number associated with the user, if available.

null
Emailstring

Email address of the user.

j.doe@namirial.com

Phonestring

Phone number of the user, if available.

null
Languagestring

Language preference of the enrollment process

it

Providerstring

Identity provider that will validate the enrollment.

bit4id

IdentificationUrlstring

Identification Provider URL to start the identification, if available.

null

EnrollUrlstring

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.
Result will be informed on "verifidResult" querystring param

OK => https://duferco.com/{dufercoId}/enroll?verifidResult=success
KO => https://duferco.com/{dufercoId}/enroll?verifidResult=error&verifidError=UnexpectedFailure

I.e. https://duferco.com/{dufercoId}/enroll


Status

...

Panel
titleExample 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",

        "Consumer": "duferco",
        "IdentificationUrl": null,
        "EnrollUrl": "https://verifid.ecertia.com/enrollment/start/018fa01b-1c42-4588-90da-dcaa52a8a236",
        "ReturnUrl": "https://duferco.com/a9474480-ffbe-4382-b2f0-9a7d7592fec2/enroll"
}

Status 401 Unauthorized

Panel
titleExample of response in JSON

{
    "Type": "https://verif.id/error/-authn",
    "Title": "There was a problem authenticating the request",
    "Details": "Authentication failed: bad token."
}

...


https://{returnUrl}?{verifIdResult=}&{verifIdError=}

QueryString ParamsValues:

  • verifidResult (string) : success | error 
  • verifidError (string) : errorcode 

...