Skip to main content
GET
/
kyb
/
companies
/
{id}
Retrieve all company info
curl --request GET \
  --url https://api.example.com/kyb/companies/{id}/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "company": {
    "companyName": "<string>",
    "country": "AF",
    "additionalInfo": {},
    "registrationNumber": "<string>",
    "region": "<string>",
    "type": "<string>",
    "phone": "<string>",
    "website": "<string>",
    "email": "jsmith@example.com",
    "brandNames": [],
    "activityCode": "<string>",
    "tin": "<string>",
    "operatingAddress": "<string>",
    "postalAddress": "<string>",
    "postcode": "<string>",
    "street": "<string>",
    "city": "<string>"
  },
  "meta": {
    "created": "2023-11-07T05:31:56Z",
    "statusChangedAt": "2023-11-07T05:31:56Z",
    "statusChangedBy": {
      "id": 123,
      "name": "<string>",
      "surname": "<string>",
      "email": "jsmith@example.com"
    },
    "assignedTo": {
      "id": 123,
      "name": "<string>",
      "surname": "<string>",
      "email": "jsmith@example.com"
    },
    "blacklistStatuses": [
      {
        "id": "<string>",
        "status": "CHECKED"
      }
    ],
    "sanctionsStatusSetBy": {
      "id": 123,
      "name": "<string>",
      "surname": "<string>",
      "email": "jsmith@example.com"
    },
    "newsStatusSetBy": {
      "id": 123,
      "name": "<string>",
      "surname": "<string>",
      "email": "jsmith@example.com"
    },
    "status": "PENDING",
    "expirationStatus": "PENDING",
    "initialSubmissionTime": "2023-11-07T05:31:56Z",
    "submissionTime": "2023-11-07T05:31:56Z",
    "matchedBlacklists": [
      "<string>"
    ],
    "automationFlags": [
      "<string>"
    ],
    "automationStatuses": {},
    "automationRanAt": "2023-11-07T05:31:56Z",
    "ipProxyRiskLevel": "VERY_LOW",
    "fraudProbLevel": "VERY_LOW",
    "sanctionsCheckStatus": "NOT_CHECKED",
    "sanctionsStatusSetAt": "2023-11-07T05:31:56Z",
    "amlComment": "<string>",
    "negativeNewsStatus": "NOT_CHECKED",
    "newsStatusSetAt": "2023-11-07T05:31:56Z",
    "negativeNewsComment": "<string>",
    "approvalStatus": "APPROVED",
    "approvalStatusChangedAt": "2023-11-07T05:31:56Z",
    "denyReason": "<string>",
    "informationRequested": true,
    "reviewLevel": "<string>",
    "soleProprietor": true
  },
  "documents": [
    {
      "created": "2023-11-07T05:31:56Z",
      "type": "INCORPORATION_CERT",
      "file": "<string>"
    }
  ],
  "beneficiaries": [
    {
      "id": "<string>",
      "info": {
        "infoType": "INDIVIDUAL",
        "name": "<string>",
        "surname": "<string>",
        "email": "jsmith@example.com",
        "phone": "<string>",
        "dateOfBirth": "2023-12-25",
        "country": "AF",
        "nationality": "AF",
        "documentNumber": "<string>",
        "personalNumber": "<string>",
        "citizenship": "AF",
        "countryOfBirth": "AF",
        "residentialAddress": "<string>",
        "countryOfResidence": "AF",
        "postcode": "<string>",
        "address": "<string>",
        "street": "<string>",
        "city": "<string>",
        "tin": "<string>",
        "taxResidence": "AF",
        "selfDeclaredPep": true,
        "additionalInfo": {}
      },
      "parent": "<string>",
      "meta": {
        "identifier": "<string>",
        "clientId": "<string>",
        "finalStatus": "<string>",
        "sessionExpiration": "2023-11-07T05:31:56Z",
        "identificationHistory": [
          {
            "scanRef": "<string>",
            "finalStatus": "<string>"
          }
        ],
        "pepsStatusSetBy": {
          "id": 123,
          "name": "<string>",
          "surname": "<string>",
          "email": "jsmith@example.com"
        },
        "sanctionsStatusSetBy": {
          "id": 123,
          "name": "<string>",
          "surname": "<string>",
          "email": "jsmith@example.com"
        },
        "newsStatusSetBy": {
          "id": 123,
          "name": "<string>",
          "surname": "<string>",
          "email": "jsmith@example.com"
        },
        "pepsCheckStatus": "NOT_CHECKED",
        "pepsStatusSetAt": "2023-11-07T05:31:56Z",
        "sanctionsCheckStatus": "NOT_CHECKED",
        "sanctionsStatusSetAt": "2023-11-07T05:31:56Z",
        "amlComment": "<string>",
        "negativeNewsStatus": "NOT_CHECKED",
        "negativeNewsComment": "<string>",
        "newsStatusSetAt": "2023-11-07T05:31:56Z"
      },
      "amlCheck": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "clientId": "<string>",
        "checkedAt": "2023-11-07T05:31:56Z",
        "created": "2023-11-07T05:31:56Z",
        "userType": "COMPANY",
        "input": {
          "fullName": "<string>",
          "nationality": "AF",
          "dateOfBirth": "2023-12-25",
          "sex": "MALE"
        },
        "filter": {
          "threshold": 85,
          "datasets": [
            "PEP_CURRENT"
          ],
          "sanctionBodies": [
            40
          ],
          "dateOfBirthMatching": "EXACT",
          "pepTiers": [
            "PEP_TIER_1"
          ]
        },
        "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"
          }
        ],
        "adverseMedia": [
          {
            "title": "<string>",
            "url": "<string>",
            "text": "<string>",
            "score": 123,
            "type": "NEGATIVE",
            "publishDate": "2023-12-25"
          }
        ],
        "overallStatus": "NOT_CHECKED",
        "monitoring": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created": "2023-11-07T05:31:56Z",
          "status": "ACTIVE",
          "isSubscribed": true,
          "expiration": "2023-11-07T05:31:56Z",
          "tags": []
        }
      },
      "amlMonitoringUser": {
        "monitoringId": "<string>",
        "alertStatus": "ALERT"
      },
      "beneficiaryType": "CEO",
      "beneficiaryTypes": [
        "CEO"
      ],
      "positions": [],
      "formFiller": true,
      "ownershipPercentage": 50,
      "documents": []
    }
  ],
  "questionnaires": [
    {
      "title": "<string>",
      "sections": [
        {
          "title": "<string>",
          "questions": [
            {
              "key": "<string>",
              "title": "<string>",
              "type": "CHECKBOX",
              "value": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "comments": [
    {
      "created": "2023-11-07T05:31:56Z",
      "content": "<string>",
      "manager": {
        "id": 123,
        "name": "<string>",
        "surname": "<string>",
        "email": "jsmith@example.com"
      }
    }
  ],
  "auditLogs": {
    "logs": [
      {
        "identifier": "<string>",
        "text": "<string>",
        "logType": "AUTOMATION",
        "logLevel": "DEBUG",
        "timestamp": "2023-11-07T05:31:56Z",
        "logId": "<string>",
        "additionalText": "<string>",
        "manager": {
          "id": 123,
          "displayName": "<string>"
        }
      }
    ],
    "logsCount": 123
  },
  "addressAudit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "googleMapsUrl": "<string>",
    "dataId": "<string>",
    "type": {},
    "address": "<string>",
    "associatedBodies": {},
    "latitude": 123,
    "longitude": 123,
    "riskLevel": "VERY_LOW",
    "addressAuditImages": [
      {
        "image": "<string>",
        "type": "STREET_VIEW"
      }
    ]
  },
  "websiteAudit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "url": "<string>",
    "riskLevel": "VERY_LOW",
    "trustScore": 50,
    "blacklistScore": 0,
    "internalAuditScore": 50,
    "popularityScore": 50,
    "domainCreatedAt": "2023-11-07T05:31:56Z",
    "websiteTitle": "<string>",
    "websiteDescription": "<string>"
  },
  "companyNameAudit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "socialMediaProfiles": [
      {
        "link": "<string>",
        "name": "<string>"
      }
    ],
    "descriptionByCompany": "<string>",
    "address": "<string>",
    "phoneNumber": "<string>",
    "industry": "<string>",
    "rating": 123
  },
  "dataMatchings": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyComparison": [
        {
          "field": "COMPANY_NAME",
          "systemValue": "<string>",
          "reportValue": "<string>",
          "match": "MATCH"
        }
      ],
      "created": "2023-11-07T05:31:56Z",
      "reportId": "<string>",
      "reportType": "KYB_DOCUMENT"
    }
  ],
  "einVerification": {
    "result": "MISMATCH",
    "checkedEin": "<string>",
    "checkedCompanyName": "<string>",
    "created": "2023-11-07T05:31:56Z"
  },
  "govChecks": {
    "creditBureauDocuments": [
      {
        "id": "<string>",
        "externalCompanyId": "<string>",
        "status": "ACTIVE",
        "checkedAt": "2023-11-07T05:31:56Z",
        "dataFile": "<string>",
        "reportFile": "<string>",
        "beneficiaryDocument": true
      }
    ],
    "govRegistersDocuments": [
      {
        "id": "<string>",
        "externalCompanyId": "<string>",
        "lite": true,
        "checkedAt": "2023-11-07T05:31:56Z",
        "dataFile": "<string>",
        "reportFile": "<string>",
        "checkedCompanyName": "<string>",
        "checkedRegistrationNumber": "<string>",
        "companyName": "<string>",
        "postcode": "<string>",
        "city": "<string>",
        "activityCode": "<string>",
        "activity": {},
        "addresses": {},
        "aliases": {},
        "email": "<string>",
        "faxNumber": "<string>",
        "telephoneNumber": "<string>",
        "fiscalCode": "<string>",
        "websiteUrl": "<string>",
        "foundationDate": "<string>",
        "legalForm": "<string>",
        "legalStatus": "<string>",
        "registrationAuthority": "<string>",
        "registrationAuthorityCode": "<string>",
        "registrationDate": "<string>",
        "registrationNumber": "<string>",
        "vatNumber": "<string>",
        "stateOfIncorporation": "<string>",
        "associatedPersons": {},
        "beneficiaryDocument": true
      }
    ],
    "govOrderedDocuments": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "expectedDeliveryTime": "2023-11-07T05:31:56Z",
        "title": "<string>",
        "documentFormat": "<string>",
        "deliveredAt": "2023-11-07T05:31:56Z",
        "status": "NOT_ORDERED",
        "file": "<string>",
        "beneficiaryDocument": true
      }
    ],
    "sosFilingDocuments": [
      {
        "id": "<string>",
        "checkedAt": "2023-11-07T05:31:56Z",
        "status": "NOT_ORDERED",
        "dataFile": "<string>",
        "reportFile": "<string>",
        "companyName": "<string>",
        "formationDate": "2023-12-25",
        "entityType": "CORPORATION",
        "watchlistHitsCount": -1,
        "beneficiaryDocument": true
      }
    ]
  },
  "amlCheck": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "clientId": "<string>",
    "checkedAt": "2023-11-07T05:31:56Z",
    "created": "2023-11-07T05:31:56Z",
    "userType": "COMPANY",
    "input": {
      "companyName": "<string>",
      "country": "AF"
    },
    "filter": {
      "threshold": 85,
      "datasets": [
        "PEP_LINKED"
      ],
      "sanctionBodies": [
        40
      ]
    },
    "amlCheck": [
      {
        "resourceId": "<string>",
        "score": 123,
        "match": "<string>",
        "name": "<string>",
        "addresses": [
          {
            "geography": "<string>",
            "city": "<string>"
          }
        ],
        "datasets": [
          "PEP"
        ],
        "currentSanBodyIds": [
          123
        ],
        "formerSanBodyIds": [
          123
        ],
        "version": 123
      }
    ],
    "adverseMedia": [
      {
        "title": "<string>",
        "url": "<string>",
        "text": "<string>",
        "score": 123,
        "type": "NEGATIVE",
        "publishDate": "2023-12-25"
      }
    ],
    "overallStatus": "NOT_CHECKED",
    "monitoring": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "status": "ACTIVE",
      "isSubscribed": true,
      "expiration": "2023-11-07T05:31:56Z",
      "tags": []
    }
  },
  "amlChecks": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clientId": "<string>",
      "checkedAt": "2023-11-07T05:31:56Z",
      "created": "2023-11-07T05:31:56Z",
      "userType": "COMPANY",
      "input": {
        "fullName": "<string>",
        "nationality": "AF",
        "dateOfBirth": "2023-12-25",
        "sex": "MALE"
      },
      "filter": {
        "threshold": 85,
        "datasets": [
          "PEP_CURRENT"
        ],
        "sanctionBodies": [
          40
        ],
        "dateOfBirthMatching": "EXACT",
        "pepTiers": [
          "PEP_TIER_1"
        ]
      },
      "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"
        }
      ],
      "adverseMedia": [
        {
          "title": "<string>",
          "url": "<string>",
          "text": "<string>",
          "score": 123,
          "type": "NEGATIVE",
          "publishDate": "2023-12-25"
        }
      ],
      "overallStatus": "NOT_CHECKED",
      "monitoring": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created": "2023-11-07T05:31:56Z",
        "status": "ACTIVE",
        "isSubscribed": true,
        "expiration": "2023-11-07T05:31:56Z",
        "tags": []
      }
    }
  ],
  "amlMonitoringUsers": [
    {
      "monitoringId": "<string>",
      "name": "<string>",
      "surname": "<string>",
      "lastCheckDate": "2023-12-25",
      "alertStatus": "ALERT"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The request must contain basic auth headers where username is API key and password is API secret.
In order for you to start using our API you will need an API key and API secret.
Both can be retrieved by contacting iDenfy's support or iDenfy's sales team.

Path Parameters

​
id
string
required

A unique value identifying this company.

Response

200 - application/json
​
id
string
required
​
company
object
required
​
meta
object
required
​
documents
object[]
required
​
beneficiaries
object[]
required
​
questionnaires
object[]
required
​
comments
object[]
required
​
auditLogs
object
required
​
addressAudit
object
required
​
websiteAudit
object
required
​
companyNameAudit
object
required
​
dataMatchings
object[]
required
​
einVerification
object
required
​
govChecks
object
required
​
amlCheck
object
required
​
amlChecks
object[]
required

Other AML checks that were performed for this company.

​
amlMonitoringUsers
object[] | null
required