Skip to content

Weavr Webhook (v2)

For Verification, create a base64 hash using HmacSHA256 using Published-Timestamp header as message and your API key as secret. The result should match the Signature header.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://weavr.io
Languages
Servers
Mock server
https://api.weavr.io/_mock/products/webhooks/openapi
https://api.weavr.io/""

Corporates

Webhooks

Corporate KYB status updateWebhook

Request

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

Headers
call-refstring

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-timestampinteger(int64)required

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

signature-v2stringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

signaturestringDeprecatedrequired

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

Bodyapplication/jsonrequired
corporateIdstring^[0-9]+$

Id of the corporate.

corporateEmailstring

Email of the corporate.

statusstring(KyiStatus)

Effective KYB status of the corporate.

Enum"UNDEFINED""NOT_STARTED""INITIATED""PENDING_REVIEW""APPROVED""REJECTED"
detailsArray of strings(CorporateKybFailureReason)

Action which my be required to re-process kyb in case of temporary rejections.

Items Enum"UNDEFINED_REQUIRED_INTERVENTION""DOCUMENTS_UNSATISFACTORY""SUPPLIED_DATA_AND_DOCUMENTS_MISMATCH""LANGUAGE_IN_DOCUMENTS_UNSUPPORTED""SELFIE_UNSATISFACTORY""SELFIE_AND_DOCUMENTS_MISMATCH""CORPORATE_DETAILS_UNSATISFACTORY""BENEFICIARY_DETAILS_UNSATISFACTORY""REPRESENTATIVE_DETAILS_UNSATISFACTORY""OTHER"
rejectionCommentstring

Reason shown to the user in case of temporary rejection.

ongoingStatusstring(KyiStatus)

Ongoing KYB Status of the corporate.

Enum"UNDEFINED""NOT_STARTED""INITIATED""PENDING_REVIEW""APPROVED""REJECTED"
application/json
{
  "corporateId": "string",
  "corporateEmail": "string",
  "status": "UNDEFINED",
  "details": [
    "UNDEFINED_REQUIRED_INTERVENTION"
  ],
  "rejectionComment": "string",
  "ongoingStatus": "UNDEFINED"
}

Responses

Success - No Content

Corporate beneficiary status updateWebhook

Request

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

Headers
call-refstring

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-timestampinteger(int64)required

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

signature-v2stringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

signaturestringDeprecatedrequired

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

Bodyapplication/jsonrequired
eventArray of strings(BeneficiaryEventType)

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.

Items Enum"STATUS_UPDATED""BENEFICIARY_TYPE_UPDATED""FIRST_NAME_UPDATED""MIDDLE_NAME_UPDATED""LAST_NAME_UPDATED""EMAIL_UPDATED"
eventDetailsArray of strings(CorporateKybFailureReason)

A reason, if any, describing why this event has occurred.

Items Enum"UNDEFINED_REQUIRED_INTERVENTION""DOCUMENTS_UNSATISFACTORY""SUPPLIED_DATA_AND_DOCUMENTS_MISMATCH""LANGUAGE_IN_DOCUMENTS_UNSUPPORTED""SELFIE_UNSATISFACTORY""SELFIE_AND_DOCUMENTS_MISMATCH""CORPORATE_DETAILS_UNSATISFACTORY""BENEFICIARY_DETAILS_UNSATISFACTORY""REPRESENTATIVE_DETAILS_UNSATISFACTORY""OTHER"
additionalInformationobject(BeneficiaryVerifiedEventAdditionalInformation)

Additional information related to the event triggering this notification.

rejectionCommentstring

Reason shown to the user in case of temporary rejection.

application/json
{
  "event": [
    "STATUS_UPDATED"
  ],
  "eventDetails": [
    "UNDEFINED_REQUIRED_INTERVENTION"
  ],
  "additionalInformation": {
    "corporateId": "string",
    "corporateName": "string",
    "rootUserEmail": "string",
    "kybStatus": "UNDEFINED",
    "beneficiary": { … },
    "documentExpiryDate": "string",
    "identityRestrictionDate": "string"
  },
  "rejectionComment": "string"
}

Responses

Success - No Content

Corporate activationWebhook

Request

Notification that a corporate identity has been activated.

Headers
call-refstring

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-timestampinteger(int64)required

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

signature-v2stringrequired

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

signaturestringDeprecatedrequired

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

Bodyapplication/jsonrequired
actionDoneBystring(ActionDoneBy)required
Enum"UNDEFINED""ADMIN""INNOVATOR"
emailAddressstringrequired
application/json
{
  "actionDoneBy": "UNDEFINED",
  "emailAddress": "string"
}

Responses

Success - No Content

Consumers

Webhooks

Managed Cards

Webhooks

Managed Accounts

Webhooks

Linked Accounts

Webhooks

Transfers

Webhooks

Send

Webhooks

Outgoing Wire Transfers

Webhooks

Manual Transactions

Webhooks

Fees

Webhooks

Login

Webhooks

Stepup

Webhooks

Authentication Factors

Webhooks

Beneficiaries

Webhooks

Bulk Operations

Webhooks

Auth Users

Webhooks