Notifications

Notifications are used by Direct ID to inform you of your customer’s user journey through Direct ID. Notifications come in two flavours, email and API.   Notifications can be used to track the successful verifications or give you real time information about the problems your users are experiencing such as incorrect username or password. 

Email Hook

The email hook can be enabled via your Account Manager.

The email hook can be configured to email you when a customer verifies his or her bank details. You can then log into the dashboard and download their transactions, or, alternatively the email hook can be configured to email you if a user experiences a problem attempting to verify themselves.

API Hook (Simple)

The Simple API hook can be enabled via your Account Manager.

The API Hook can be configured to call an endpoint on your backend system in the result of success or user error. 

Success Hook

The success hook will contain your Unique ID passed back to you as well as our internal reference, The internal reference is required to access any of our endpoints about that individual.   

 

Request Details

  • The Http Method will always be POST
  • The Content Type will always be application/json
  • The request body will contain the following JSON:
{
 "rpUser_Id":"<your user id>",
 "user_id":"<our user id>"
}
  • rpUser_Id will return your userid if you have set one
  • user_id will return our userid 

 

A diagram of the process is below:-

API Hook Flow

Error Hooks

The error hook can be enabled via your account manager.  When your users experience a problem the hook is triggered to inform you of the user issue so you can help your users fix the problem asap.

 

Request Details

  • The Http Method will always be POST
  • The Content Type will always be application/json
  • The request body will contain the following JSON:
{
 "error_code": "<the error code>",
 "error_message": "<the error message>",
 "user_id": "<our user id>",
 "rpUser_Id": "<your user id>"
}
  • rpUser_Id will return your user id if you have set one
  • user_id will return our user id 
  • error_code will return our internal error code
  • error_message will return our error message to help you help your customers with their issue

API Hooks (oAuth2)

Alternatively, if you want to make sure that no one can call your endpoint except verified clients, we can enable our server to connect to your OAuth2 authorisation server and get an access token which we then send to you in the same way you connect to our OAuth2 provider to authenticate you to use our API. In addition to the data listed above, we will require the following details:-

  • A Client ID for your OAuth authorisation server
  • A Secret Key for your OAuth authorisation server
  • An endpoint to request the User Session Token