Notifications
The Identity verification service optionally posts an update notification every time the session state changes, based on the selected subscription topics.
x
const notificationConfig = new NotificationConfigBuilder() .withEndpoint('https://yourdomain.example/idverify/updates') .withAuthToken('username:password') .forResourceUpdate() .forTaskCompletion() .forCheckCompletion() .forSessionCompletion() .build();const sessionSpec = new SessionSpecificationBuilder() // ... .withNotifications(notificationConfig) // ... .build();Below are the different updates Yoti can provide:
| Notification | Description |
|---|---|
| withEndpoint | Endpoint for notifications to be sent to. Only HTTPS endpoints with TLS 1.2 are supported. A POST message will be sent. Exposing this endpoint is not mandatory but highly recommended as it would avoid a continuous polling on the session retrieval endpoint. |
| withAuthToken | Allows the relying business backend to define an authorisation token, if they have secured API endpoints, allowing Yoti to call endpoints. We recommend protecting any exposed routes with basic authorisation. This should be used in conjunction with either 'withAuthTypeBasic' or 'withAuthTypeBearer' |
| withAuthTypeBasic | You may specify a basic auth token to the Identity verification API to be used when sending notifications to your endpoint. Credentials are automatically encoded as base64 and sent in the Authorisation header. For example "auth_token": "username:password" would result in Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= being sent into the request header from Yoti. |
| withAuthTypeBearer | This allows use of the bearer token standard, the system will create the header as follows, using the entry from withAuthToken: Authorization: Bearer |
| forResourceUpdate | Update received whenever there are changes to resources in the session. For example, a user uploading a new document. |
| forTaskCompletion | Sent when a task is completed. If you require TEXT_EXTRACTION and the check has been fulfilled, Yoti will send this through as an update to your endpoint. |
| forSessionCompletion | Triggered when all tasks and all checks inside of a given session have been completed. |
| forCheckCompletion | Sent when a check completes – for example a document authenticity check being performed. |
Optionally, it is possible to specify a Webhook URL when creating a request to be informed of any changes that occur within the session. This avoids the need to poll for updates. Here is an example object that can be provided to the API which specifies a notifications endpoint, and a list of topics to be subscribed to.
Example response
{ // Always provided "session_id" : "<uuid>", "topic" : "resource_update", // | "task_completion" | "check_completion" | "session_completion" // Optional and present only when "topic" is "task_completion" "task_id" : "<uuid>", // Optional and present only when "topic" is "resource_update" "resource_id" : "<uuid>", // Optional and present only when "topic" is "check_completion" "check_id" : "<uuid>" }Was this page helpful?