Skip to main content
WEBHOOK
companyReview
{
  "companyName": "<string>",
  "statusChangedBy": {
    "username": "<string>",
    "email": "jsmith@example.com",
    "name": "<string>",
    "surname": "<string>"
  },
  "sanctionsStatusSetBy": {
    "username": "<string>",
    "email": "jsmith@example.com",
    "name": "<string>",
    "surname": "<string>"
  },
  "amlCheck": {
    "overallStatus": "NOT_CHECKED",
    "statusSetAt": "2023-11-07T05:31:56Z",
    "adverseMedia": [
      {
        "title": "<string>",
        "url": "<string>",
        "text": "<string>",
        "score": "<string>",
        "type": "<string>",
        "publishDate": "<string>",
        "status": "<string>"
      }
    ],
    "amlCheck": [
      {
        "resourceId": "<string>",
        "score": 123,
        "match": "<string>",
        "name": "<string>",
        "addresses": [
          {
            "geography": "<string>",
            "city": "<string>"
          }
        ],
        "datasets": [
          "PEP"
        ],
        "currentSanBodyIds": [
          123
        ],
        "formerSanBodyIds": [
          123
        ],
        "version": 123
      }
    ]
  },
  "beneficiaries": [
    {
      "pepsStatusSetBy": {
        "username": "<string>",
        "email": "jsmith@example.com",
        "name": "<string>",
        "surname": "<string>"
      },
      "sanctionsStatusSetBy": {
        "username": "<string>",
        "email": "jsmith@example.com",
        "name": "<string>",
        "surname": "<string>"
      },
      "newsStatusSetBy": {
        "username": "<string>",
        "email": "jsmith@example.com",
        "name": "<string>",
        "surname": "<string>"
      },
      "amlCheck": {
        "overallStatus": "NOT_CHECKED",
        "statusSetAt": "2023-11-07T05:31:56Z",
        "adverseMedia": [
          {
            "title": "<string>",
            "url": "<string>",
            "text": "<string>",
            "score": "<string>",
            "type": "<string>",
            "publishDate": "<string>",
            "status": "<string>"
          }
        ],
        "amlCheck": [
          {
            "resourceId": "<string>",
            "score": 123,
            "match": "<string>",
            "name": "<string>",
            "addresses": [
              {
                "geography": "<string>",
                "city": "<string>"
              }
            ],
            "nationalities": [
              "AF"
            ],
            "datesOfBirth": [
              "<string>"
            ],
            "datasets": [
              "PEP_CURRENT"
            ],
            "currentSanBodyIds": [
              123
            ],
            "formerSanBodyIds": [
              123
            ],
            "version": 123,
            "gender": "MALE",
            "profileImage": "<string>",
            "pepTier": "PEP_TIER_1"
          }
        ]
      },
      "amlComment": "<string>",
      "pepsCheckStatus": "NOT_CHECKED",
      "pepsStatusSetAt": "2023-11-07T05:31:56Z",
      "sanctionsCheckStatus": "NOT_CHECKED",
      "sanctionsStatusSetAt": "2023-11-07T05:31:56Z",
      "negativeNewsComment": "<string>",
      "negativeNewsStatus": "NOT_CHECKED",
      "newsStatusSetAt": "2023-11-07T05:31:56Z"
    }
  ],
  "newsStatusSetBy": {
    "username": "<string>",
    "email": "jsmith@example.com",
    "name": "<string>",
    "surname": "<string>"
  },
  "clientId": "<string>",
  "registrationNumber": "<string>",
  "approvalStatus": "APPROVED",
  "denyReason": "<string>",
  "soleProprietor": true,
  "amlComment": "<string>",
  "sanctionsCheckStatus": "NOT_CHECKED",
  "sanctionsStatusSetAt": "2023-11-07T05:31:56Z",
  "negativeNewsComment": "<string>",
  "negativeNewsStatus": "NOT_CHECKED",
  "newsStatusSetAt": "2023-11-07T05:31:56Z",
  "externalRef": "<string>",
  "relatedClientScanRefs": [
    "<string>"
  ]
}

Headers

Idenfy-Event-Type
enum<string>
required
Available options:
COMPANY_REVIEW
Idenfy-Signature
string

Webhook signature

Body

application/json
companyName
string
required
Maximum string length: 255
statusChangedBy
object
required
sanctionsStatusSetBy
object
required
deprecated
amlCheck
object
required
beneficiaries
object[]
required
newsStatusSetBy
object
required
deprecated
clientId
string
required

A unique string identifying a client on your side.

Maximum string length: 100
registrationNumber
string | null
Maximum string length: 100
approvalStatus
enum<string>

Review approval status.

Available options:
APPROVED,
DENIED
denyReason
string | null

The reason why this KYB form was denied.

Maximum string length: 64
soleProprietor
boolean
amlComment
string | null
deprecated

DEPRECATED

sanctionsCheckStatus
enum<string>
deprecated

DEPRECATED

Available options:
NOT_CHECKED,
NO_FLAGS,
FALSE_POSITIVE,
TRUE_POSITIVE,
FLAGS_FOUND
sanctionsStatusSetAt
string<date-time> | null
deprecated

DEPRECATED

negativeNewsComment
string | null
deprecated

DEPRECATED

negativeNewsStatus
enum<string>
deprecated

DEPRECATED

Available options:
NOT_CHECKED,
NO_FLAGS,
FALSE_POSITIVE,
TRUE_POSITIVE,
FLAGS_FOUND
newsStatusSetAt
string<date-time> | null
deprecated

DEPRECATED

externalRef
string | null

Any additional value chosen by you.

Maximum string length: 40
Maximum string length: 40
Pattern: ^[^,]+$

Response

200

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