ItsMe is a trusted identity provider allowing partners to use verified identities for authentication and authorization on web desktop, mobile web and mobile applications.

Start: POST to

Result: GET from
where env is API or test sessionid is the session identifier retrieved from the setup call, named id in the response.


env is API or test 

languageSupported values are: “fr”“nl”“en” and “de”. Any other value will be ignored.No

This optional parameter will be returned to you at the redirect back to your server. Use it to link an unique ID of your choice that you can parse.

Example: relaystate=zignsec_eid_1234

targetIf this parameter is supplied the browser session will finally be redirected to this URL-value.No
targetErrortargetError works as target except it is navigated on user cancel or error situations.No
webhookA URL where success/error results will automatically be POST:edNo

Each request returns a response with status and details.

idA unique session identifier generated for each workflow instance.
errorsA JSON array of error conditions, see error handling.
redirectUrlItsMe redirect url
    "id": "9dc96404-7c0f-4997-bf94-3cd7f9de41b0",
    "redirectUrl": "",
    "errors": []

GET to

env is API or test 

How to get notified when workflow is finished:

There is both active and passive notification for when the workflow is finished

  • Callback: Set target and targetError URL parameter in step 1 and you can do the above GET when navigation will occur.
  • Webhook. You can set webhook URL parameter in step step 1 Result will be posted to the URL.
  • Polling: Repeatedly call the above collect-GET until the results contain a final result.
    "id": "9dc96404-7c0f-4997-bf94-3cd7f9de41b0",
    "state": "Finished",
    "errors": [],
    "identity": {
        "countryCode": "BE",
        "firstName": "Florent Verschueren",
        "lastName": "Verschueren",
        "fullName": "Florent Verschueren Verschueren",
        "personalNumber": "",
        "dateOfBirth": "1980-01-02",
        "age": 41,
        "gender": "male",
        "phone": "+32 425009714",
        "email": "[email protected]",
        "addressInfoRaw": "Havenlaan 2,Brussel,1000",
        "idProviderName": "ItsMe",
        "identificationDate": "2021-05-11T16:34:19.6727354Z",
        "idProviderAuthenticityScore": "NOT_SET"
    "providerData": "{\"sub\":\"1pjoxjqmuxdswhdqiarsxwsekxrwf1hfdvw9\",\"aud\":\"Nqs0C2dKKA\",\"eid\":null,\"birthdate\":\"1980-01-02\",\"city_of_birth\":null,\"gender\":\"male\",\"name\":\"Florent Verschueren\",\"iss\":\"\",\"phone_number\":\"+32 425009714\",\"phone_number_verified\":true,\"given_name\":\"Florent\",\"family_name\":\"Verschueren\",\"locale\":\"fr\",\"email\":\"[email protected]\",\"email_verified\":false,\"address\":\"{\\\"country\\\":\\\"BE\\\",\\\"street_address\\\":\\\"Havenlaan 2\\\",\\\"locality\\\":\\\"Brussel\\\",\\\"postal_code\\\":\\\"1000\\\"}\",\"ParsedAddress\":{\"country\":\"BE\",\"street_address\":\"Havenlaan 2\",\"locality\":\"Brussel\",\"postal_code\":\"1000\"},\"nationality\":null,\"photo\":null,\"device\":null}"