Profile

Profile webhooks are used to communicate profile status updates to the client-server.

You will receive a notification via webhook whenever the profile status changes since the query template responsible for profile creation has a profile webhook set up.

Setting up the webhook

To configure the profile webhook URL of a query template, navigate to the Query Templates menu on the CAF Trust Platform and enter the desired template and edit the Profile webhook field.

  • Each Query Template created in the CAF Trust Platform will need a call-back URL assigned for the profile webhook. This URL can be different across active templates or the same.

  • The configured URL must be ready to expect a POST request following a CAF service execution.

Webhook response parameters

Example webhook post:

{
  "profileId": "6021a21b3811c35ecb8dea20",
  "type": "PF",
  "status": "REPROVED",
  "updatedAt": "2023-01-24T12:10:21.311Z",
  "cpf": "00011122233"
}

Last updated

Logo

2023 © Caf. - All rights reserved