ClientKYCDocumentsUpdatedV1

v1.0.0

{
  "$id": "https://example.com/ClientKYCDocumentsUpdatedV1.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ClientKYCDocumentsUpdatedV1",
  "description": "An event raised when a client's KYC documents are updated",
  "type": "object",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "occurredAtUtc": {
          "type": "string",
          "description": "The date and time when event occurred in UTC. Date should be represented in ISO 8601 format e.g 2023-09-08T12:00:00Z"
        },
        "typeName": {
          "type": "string",
          "description": "The name of the event. E.g ClientKYCDocumentsUpdatedV1"
        },
        "source": {
          "type": "string",
          "description": "The source of the event like was it genereated by Client using Web or WeChat"
        },
        "applicationBreadcrumb": {
          "type": "string",
          "description": "Th application path which is describing the chain of applications. For e.g my-christies-web-ui;3.0.1:follows-api;v1.1.0"
        },
        "version":{
          "type": "string",
          "description": "The version of the message in semantic versioning format ideally V{major.minor.patch}. E.g V1.0.0 or just V{majorVersion}"
        }, 
        "sentAtUtc": {
          "type": "string",
          "description":  "When event was sent by the publishers in ISO 8601 "
        },
        "isTransactionalAccountAvailableForClient": {
          "type": "boolean",
          "description":  "Indicates if the transaction account for a client is available"
      },
      "required": [ "occurredAtUtc", "typeName", "sentAtUtc", "version", "isTransactionalAccountAvailableForClient"]
    }
  },
    "data": {
      "type": "object",
      "properties": {
        "client": {
          "type": "object",
          "properties": {
            "globalClientId": {
              "type": "string",
              "description": "The GUID of client"
            },
            "clientNumber": {
              "type": "number",
              "description": "The CRM number of the client"
            },
            "type": {
              "type": "string",
              "description": "The type of client, e.g. Person or Organisation"
            }
          }
        },
        "kycDocuments":{
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
               "identityReferenceNumber":{
                "type" : "string",
                "description": "The identity reference number of KYC document."
              },
              "country" : {
                "type" : "string",
                "description": "The country of issuance of KYC document."
              },
              "type": {
                "type": "string",
                "description": "Allowed values Passport, Driving License, National ID card and Other"
              },
              "expiryAt": {
                "type": "string",
                "description": "The expiry date of KYC document in ISO 8601 format e.g 2023-09-08"
              },
              "effectiveAt":{
                "type": "string",
                "description": "The effective date of KYC document in ISO 8601 format e.g 2023-09-08"
              },
              "isPrimary":{
                "type": "boolean",
                "description": "Indicates if this is the primary KYC document for the client"
              }
            }
          }
        }
        
      }
    }
  }
}