Supplier Data Model

Overview

The "Supplier Status Changed" webhook is triggered whenever there is an update to the status of a supplier in the system. This webhook ensures that your system is notified of any changes in supplier status, allowing for real-time updates and appropriate actions.

Your webhook endpoint will receive a POST request containing an event with a Code of 4 and Name of SUPPLIER_STATUS_CHANGED. This event is particularly useful for monitoring supplier verifications and KYC (Know Your Customer) decision updates.

Request Model

The webhook payload consists of multiple nested objects containing essential supplier status details.

Event Object

Input Parameter	Type	Description
Event.Code	number	4 - SUPPLIER_STATUS_CHANGED
Event.Name	string	SUPPLIER_STATUS_CHANGED
Event.CountryIsoCode	string	The country of your account with MyFatoorah.
Event.CreationDate	datetime	The timestamp when the event was created in ISO 8601 format.
Event.Reference	string	Unique reference ID for the webhook event.

Data Object

The Data Object contains multiple nested objects as below.

Supplier Object

Input Parameter	Type	Description
Supplier.Code	number	Unique identifier for the supplier.
Supplier.Name	string	The name of the supplier.
Supplier.Mobile	string	The mobile phone number of the supplier.
Supplier.Email	string	The email address of the supplier.

KYC Decision Object

Input Parameter	Type	Description
KycDecision.Status	string	The current status of the supplier’s KYC verification (e.g., APPROVED - REJECTED).
KycDecision.Comments	string	Any additional comments related to the KYC decision.
KycDecision.RejectionReason	array	If rejected, contains the reasons for rejection.

Rejection Reasons Object

You can find here all the Rejection Reasons.

Input Parameter	Type	Description
RejectionReason[ ].Code	string	The rejection reason code.
RejectionReason[ ].Description	string	Description of the rejection reason.

Business Category Object

Input Parameter	Type	Description
BusinessCategory.Code	string	The MCC Code for the supplier
BusinessCategory.Name	string	The name of the MCC Code for the supplier

Sample Event

The below sample JSON message is sent by MyFatoorah to your endpoint.

{
  "Event": {
    "Code": 4,
    "Name": "SUPPLIER_STATUS_CHANGED",
    "CountryIsoCode": "KWT",
    "CreationDate": "2025-05-13T06:25:26.7400000Z",
    "Reference": "WH-128071"
  },
  "Data": {
    "Supplier": {
      "Code": 279,
      "Name": "May Nicolas",
      "Mobile": "8237751513",
      "Email": "[email protected]"
    },
    "KycDecision": {
      "Status": "APPROVED",
      "Comments": "",
      "RejectionReason": []
    },
    "BusinessCategory": {
      "Code": "5814",
      "Name": "Cafes"
    }
  }
}

{
  "Event": {
    "Code": 4,
    "Name": "SUPPLIER_STATUS_CHANGED",
    "CountryIsoCode": "KWT",
    "CreationDate": "2025-05-13T06:28:55.2600000Z",
    "Reference": "WH-128075"
  },
  "Data": {
    "Supplier": {
      "Code": 273,
      "Name": "Daryl Sauer",
      "Mobile": "5089201194",
      "Email": "[email protected]"
    },
    "KycDecision": {
      "Status": "APPROVED",
      "Comments": "",
      "RejectionReason": [
        {
          "Code": "1",
          "Description": "Expired Company License"
        },
        {
          "Code": "7",
          "Description": "Expired Authorise Signatory - Kuwait"
        },
        {
          "Code": "30",
          "Description": "Unclear Bank approval letter- Home Business"
        },
        {
          "Code": "37",
          "Description": "Using Personal bank"
        },
        {
          "Code": "58",
          "Description": "Update Commercial Registeration to include the activity"
        },
        {
          "Code": "65",
          "Description": "Wrong email, require to register again"
        },
        {
          "Code": "75",
          "Description": "No Product"
        }
      ]
    },
    "BusinessCategory": {
      "Code": "5941",
      "Name": "Camping products"
    }
  }
}

Webhook Signature

You will use the parameters mentioned below to generate the webhook signature for the SUPPLIER_STATUS_CHANGED event.

Supplier.Code=279,KycDecision.Status=APPROVED

This webhook allows real-time tracking of supplier status changes, including verification and rejection updates, ensuring compliance and verification processes in your system.