Buyers

Buyers are identities representing companies. Once on-boarded, Buyers can create and manage their own instruments via your application.

Buyer KYB status updateWebhook

Notification that the KYB status of a buyer identity has been updated.

Request
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
required
integer <int64>

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signature
required
string

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
required
string

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 Body schema: application/json
required
type
string
Value: "buyerKYBWatch"
object
Responses
200

Return a 200 status to indicate that the data was received successfully

Request samples
application/json
{
  • "type": "buyerKYBWatch",
  • "payload": {
    }
}

Buyer Beneficiary status updateWebhook

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

Request
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
required
integer <int64>

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signature
required
string

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
required
string

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 Body schema: application/json
required
type
string
Value: "buyerBeneficiaryStatusWatch"
object
Responses
200

Return a 200 status to indicate that the data was received successfully

Request samples
application/json
{
  • "type": "buyerBeneficiaryStatusWatch",
  • "payload": {
    }
}

Buyer updateWebhook

Notification that a buyer has been updated.

Request
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
required
integer <int64>

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signature
required
string

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
required
string

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 Body schema: application/json
required
type
string
Value: "buyerActivatedWatch"
object
Responses
200

Return a 200 status to indicate that the data was received successfully

Request samples
application/json
{
  • "type": "buyerActivatedWatch",
  • "payload": {
    }
}

Buyer deactivationWebhook

Notification that a buyer identity has been deactivated.

Request
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
required
integer <int64>

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signature
required
string

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
required
string

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 Body schema: application/json
required
type
string
Value: "buyerDeactivatedWatch"
object
Responses
200

Return a 200 status to indicate that the data was received successfully

Request samples
application/json
{
  • "type": "buyerDeactivatedWatch",
  • "payload": {
    }
}