Versions Compared

Key

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

...

FieldTypeDescriptionExample
Profilestring

Required profile to identify how to enroll the user

Bit4Id::SPIDOnly::Duferco

Languagestring

Language preference for UI and documents to be generated on enrollment. Typically uses ISO 639-1 codes.

it

Emailstring

The email address of the user. Must be a valid email format.

j.doe@namirial.com

FirstNamestringThe first name of the user.

John

LastNamestring

The last name of the user.

Doe

ReturnUrlstring

The URL to which the user will be redirected after enrollment. Must be a valid URL.

https://duferco.com/{id}/enroll


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/enroll/

}

...

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

ReturnUrlstring

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=Server::UnexpectedFailureI.e. https://duferco.com/{dufercoId}/enroll

QueryString Params:

  • verifidResult = success | error (string)
  • verifidError = errorcode (string formated as Error::SubError)

    TODO: List of errors pending to be updated


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



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"
}

...