# Buyer Beneficiary status update

Notification that the verification status of a buyer beneficiary has been updated.

Endpoint: POST buyerBeneficiaryStatusWatch
Version: v1
Security: 

## Header parameters:

  - `call-ref` (string)
    A call reference generated by the caller and unique to the caller
to provide correlation between the caller and system with a maximum length
of 255

  - `published-timestamp` (integer, required)
    The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

  - `signature` (string, required)
    The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

  - `signature-v2` (string, required)
    The signature to verify the authenticity of this request.  This is the base64 hash (HmacSHA256) of the call-ref header, the request body, and the published-timestamp header, all concatenated without spaces, and signed using your API key.

## Request fields (application/json):

  - `type` (string)
    Enum: "buyerBeneficiaryStatusWatch"

  - `payload` (object)

  - `payload.event` (array)
    The event that triggered this webhook notification. The event
is structured to describe the parameter that has triggered the event followed
by the action that occurred.
    Enum: "STATUS_UPDATED", "BENEFICIARY_TYPE_UPDATED", "FIRST_NAME_UPDATED", "MIDDLE_NAME_UPDATED", "LAST_NAME_UPDATED", "EMAIL_UPDATED"

  - `payload.eventDetails` (array)
    A reason, if any, describing why this event has occurred.
    Enum: "BUYER_DETAILS_UNSATISFACTORY", "ADMIN_USER_UNMATCHED_TO_DIRECTOR_OR_REPRESENTATIVE", "UNDEFINED_REQUIRED_INTERVENTION", "DOCUMENTS_UNSATISFACTORY", "SUPPLIED_DATA_AND_DOCUMENTS_MISMATCH", "LANGUAGE_IN_DOCUMENTS_UNSUPPORTED", "SELFIE_UNSATISFACTORY", "SELFIE_AND_DOCUMENTS_MISMATCH", "BENEFICIARY_DETAILS_UNSATISFACTORY", "REPRESENTATIVE_DETAILS_UNSATISFACTORY", "OTHER", "UNSUPPORTED_COUNTRY", "EXPIRED_KYC_DOCUMENTS"

  - `payload.additionalInformation` (object)
    Additional information related to the event triggering this notification.

  - `payload.additionalInformation.buyerId` (string)
    The buyer id whose beneficiary has triggered this event.

  - `payload.additionalInformation.buyerName` (string)
    The buyer name whose beneficiary has triggered this event.

  - `payload.additionalInformation.adminUserEmail` (string)
    The buyer's root user email.

  - `payload.additionalInformation.kybStatus` (string)
    The status of the Full Company Verification Checks for the buyer entity.
    Enum: "NOT_STARTED", "INITIATED", "PENDING_REVIEW", "APPROVED", "REJECTED"

  - `payload.additionalInformation.beneficiary` (object)

  - `payload.additionalInformation.beneficiary.type` (string)
    Type of the beneficiary.
    Enum: "UNDEFINED_BENEFICIARY_TYPE", "UBO", "DIRECTOR", "UNKNOWN", "SHAREHOLDER", "PARTNER", "OTHER_DIRECTOR"

  - `payload.additionalInformation.beneficiary.firstName` (string)
    First name of the beneficiary.

  - `payload.additionalInformation.beneficiary.middleName` (string)
    Middle name of the beneficiary.

  - `payload.additionalInformation.beneficiary.lastName` (string)
    Last name of the beneficiary.

  - `payload.additionalInformation.beneficiary.email` (string)
    Email of the beneficiary.

  - `payload.additionalInformation.beneficiary.status` (string)
    Effective KYB Status of the beneficiary.
    Enum: "NOT_STARTED", "INITIATED", "PENDING_REVIEW", "APPROVED", "REJECTED"

  - `payload.additionalInformation.beneficiary.ongoingKybStatus` (string)
    Ongoing KYB Status of the beneficiary.
    Enum: "NOT_STARTED", "INITIATED", "PENDING_REVIEW", "APPROVED", "REJECTED"

  - `payload.rejectionComment` (string)
    Reason shown to the user in case of temporary rejection.


## Response 200 fields