webhook-event
verification

Additional verification state change

This event pushes updates for the Additional Customer Verification process. See the Webhooks guide for setup instructions, signature verification, and best practices.

Events may not be delivered in the order they occurred. Use data.occurred_at to reconcile the order. See the Event Ordering guide for details.

  • Event type: profiles#cdd-check-state-change
  • Profile level subscriptions: Not Supported
  • Application level subscriptions: Supported

Verification state values

CodeDescription
VERIFIEDAdditional verification check has passed
EVIDENCE_REQUIREDAdditional verification check has failed, evidences are required

Review outcome values

CodeDescription
DOCUMENT_POOR_QUALITYDocument quality poor
DOCUMENT_OUT_OF_DATEDocument out of date
DOCUMENT_NAME_MISMATCHName on document does not match records
DOCUMENT_MISSING_NAMEName on document missing
DOCUMENT_MISSING_ISSUE_DATEDocument issue date missing
DOCUMENT_MISSING_COMPANY_LOGO_LETTERHEADCompany logo or letterhead missing from document
DOCUMENT_NOT_COMPLETEDocument is partially cut-off and does not contain full information
DOCUMENT_MISSING_SIGNATUREDocument missing signature
DOCUMENT_MISSING_INCOMEDocument missing income information or income is not clear from the document
DOCUMENT_TYPE_UNACCEPTABLESubmitted document type is not acceptable
INVOICE_UNACCEPTABLEInvoice is not an accepted document
PHOTO_ID_UNACCEPTABLEPhoto ID is not an accepted document
TRANSACTION_UNACCEPTABLETransaction (or a screenshot of a transaction) is not accepted
PHOTO_UNACCEPTABLEPhotos (or computer screenshots) are not acceptable
OTHERReason unknown

Required evidence values

Go to the list of evidences to find all possible values.

postWebhookprofiles#cdd-check-state-change

Headers

X-Signature-SHA256string

RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the Wise public key to ensure the request is authentic and has not been tampered with.

X-Delivery-Idstring uuid

Unique identifier for this webhook delivery attempt.

X-Test-Notificationboolean

Present with the value true if this is a test notification sent to verify your callback URL during subscription setup.

Payload

OR

Example payload

{
  "schema_version": "4.0.0",
  "subscription_id": "01234567-89ab-cdef-0123-456789abcdef",
  "event_type": "profiles#cdd-check-state-change",
  "sent_at": "2020-01-01T12:34:56.123Z",
  "data": {
    "resource": {
      "type": "profile",
      "id": 111
    },
    "current_state": "VERIFIED",
    "review_outcome": "DOCUMENT_OUT_OF_DATE",
    "required_evidences": [
      "SOURCE_OF_INCOME"
    ],
    "occurred_at": "2020-01-01T12:34:56.789Z",
    "source_of_income": "INVESTMENTS",
    "source_of_funding": "REVENUE"
  }
}

Response

Return any 2xx status to acknowledge receipt of the event.

statusstring

Example response

{
  "status": "ok"
}

Changes