ItsMe is a trusted identity provider allowing partners to use verified identities for authentication and authorization on web desktop, mobile web and mobile applications.
Parameter | Description | Required |
---|---|---|
language | Supported values are: “fr”, “nl”, “en” and “de”. Any other value will be ignored. | No |
relaystate | 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: | No |
target | If this parameter is supplied the browser session will finally be redirected to this URL-value. | No |
targetError | targetError works as target except it is navigated on user cancel or error situations. | No |
webhook | A URL where success/error results will automatically be POST:ed | No |
Each request returns a response with status and details.
id | A unique session identifier generated for each workflow instance. |
errors | A JSON array of error conditions, see error handling. |
redirectUrl | ItsMe redirect url |
{ "id": "9dc96404-7c0f-4997-bf94-3cd7f9de41b0", "redirectUrl": "https://e2emerchant.itsme.be/oidc/authorization?client_id=Nqs0C2dKKA&response_type=code&scope=openid+service%3aZIGNSECSBX_LOGIN+profile+email+phone+address+eid&redirect_uri=https%3a%2f%2flocalhost%3a44381%2fapi%2fv3%2fcallbacks%2fitsme%2fidentSuccess%2fa51679f7-1cda-4c10-a998-d253a01093e9", "errors": [] }
GET to https://env
.zignsec.com/v3/eid/itsme/sessionid
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
{ "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\":\"https://e2emerchant.itsme.be/oidc\",\"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}" }