Versions Compared

Key

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

...

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=UnexpectedFailure

QueryString Params:

  • verifidResult = success | error (string)
  • verifidError = errorcode (string)
    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/a9474480-ffbe-4382-b2f0-9a7d7592fec2/enroll"
    }


    Return URL 


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

    QueryString Params:

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


    Error Codes

    CodeDescription
    NotSupportedDocumentIdentity Document provided during validation is not supported
    RequestAlteredInfoProvided verification info as been altered during OnBoarding process
    RequestIsExpiredCurrent request is expired
    RequestInvalidInfoEnrollment request data is not correct
    UnexpectedFailureUnexpected failure while processing the Enrollment
    OnBoardingProviderErrorProblems occured with Onboarding Provider
    PdfValidationErrorPdf Certificate validation has failed