For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
API GuideAPI ReferenceChangelog
API GuideAPI ReferenceChangelog
  • API Reference
  • Webhook Reference
      • POSTCustomer Status Updated Event
LogoLogo
Webhook ReferenceCustomers

Customer Status Updated Event

Payload
1{
2  "customer_id": "string",
3  "status": "active",
4  "unique_identifier": "string",
5  "contacts": [
6    {
7      "contact_id": "string",
8      "first_name": "string",
9      "last_name": "string",
10      "status": "active"
11    }
12  ]
13}
Sent when a customer's status changes to Active or Inactive. For instance, when a Customer is first created it will have a status of "Inactive" until the required documents have been uploaded and checked. A change of status could also be the result of a modification to existing data. For instance, a Contact could upload a new Proof of Identity document, which would cause their status to become "Inactive" until the document has been reviewed. Once you have subscribed to the "CUSTOMER STATUS" event type, Redpin will call your designated API endpoint with the payloads described below when there is an update to one of your Customer's Statuses. **Active Customer Example:** ```json { "customer_id": "0201000005926289", "status": "active", "unique_identifier": "2df806d1-028f-405e-8a53-332b7b039d7b", "contacts": [ { "contact_id": "4349165556", "first_name": "Saurabh", "middle_name": "Rajendra", "last_name": "Sarcar", "status": "active" } ] } ``` **Inactive Customer Example:** ```json { "customer_id": "0201000005926289", "status": "inactive", "unique_identifier": "a8509765-a76d-4c20-9ebf-c2b0f08ab187", "reason_for_inactive": "Identity document", "documents_required": [ { "document_type": "POI", "uri": "/v1/customers/0201000005926289/contacts/4349165556/documents/0011q00000DA0MfAAL-0011q00000ab0xdf46" } ], "contacts": [ { "contact_id": "4349165556", "first_name": "Saurabh", "middle_name": "Rajendra", "last_name": "Sarcar", "status": "active", "documents_required": [ { "document_type": "POI", "uri": "/v1/customers/0201000005926289/contacts/4349165556/documents/0011q00000DA0MfAAL-0011q00000ab0xdf46" } ] } ] } ```
Was this page helpful?
Previous

Virtual Account Status Updated Event

Next
Built with

Sent when a customer’s status changes to Active or Inactive. For instance, when a Customer is first created it will have a status of “Inactive” until the required documents have been uploaded and checked. A change of status could also be the result of a modification to existing data. For instance, a Contact could upload a new Proof of Identity document, which would cause their status to become “Inactive” until the document has been reviewed.

Once you have subscribed to the “CUSTOMER STATUS” event type, Redpin will call your designated API endpoint with the payloads described below when there is an update to one of your Customer’s Statuses.

Active Customer Example:

1{
2  "customer_id": "0201000005926289",
3  "status": "active",
4  "unique_identifier": "2df806d1-028f-405e-8a53-332b7b039d7b",
5  "contacts": [
6    {
7      "contact_id": "4349165556",
8      "first_name": "Saurabh",
9      "middle_name": "Rajendra",
10      "last_name": "Sarcar",
11      "status": "active"
12    }
13  ]
14}

Inactive Customer Example:

1{
2  "customer_id": "0201000005926289",
3  "status": "inactive",
4  "unique_identifier": "a8509765-a76d-4c20-9ebf-c2b0f08ab187",
5  "reason_for_inactive": "Identity document",
6  "documents_required": [
7    {
8      "document_type": "POI",
9      "uri": "/v1/customers/0201000005926289/contacts/4349165556/documents/0011q00000DA0MfAAL-0011q00000ab0xdf46"
10    }
11  ],
12  "contacts": [
13    {
14      "contact_id": "4349165556",
15      "first_name": "Saurabh",
16      "middle_name": "Rajendra",
17      "last_name": "Sarcar",
18      "status": "active",
19      "documents_required": [
20        {
21          "document_type": "POI",
22          "uri": "/v1/customers/0201000005926289/contacts/4349165556/documents/0011q00000DA0MfAAL-0011q00000ab0xdf46"
23        }
24      ]
25    }
26  ]
27}

Payload

The payload of this webhook request is an object.
customer_idstringRequired
Unique identifier for the customer
statusenumRequired
Whether the customer is active or inactive
Allowed values:
unique_identifierstringRequired

When the customer is active, this is the Unique ID for this Customer provided by the Register a Customer operation. When inactive, this is a temporary identifier for tracking the status change.

contactslist of objectsRequired
Array of contacts associated with the customer
customer_typestringOptional
Registering customer type
reason_for_inactivestringOptional
When the customer is inactive, this will be the reason for it being inactive. Only present when status is "inactive".
documents_requiredlist of objectsOptional
When there are outstanding documents for a Customer, this is an array of document objects. Only present when status is "inactive".

Response

200
Webhook received successfully
400
Invalid payload