Retrieve all company info

GET /kyb/companies/{id}/

Retrieve all company info

cURL

curl --request GET \
  --url https://ivs.idenfy.com/kyb/companies/{id}/ \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://ivs.idenfy.com/kyb/companies/{id}/"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://ivs.idenfy.com/kyb/companies/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.get("https://ivs.idenfy.com/kyb/companies/{id}/")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ivs.idenfy.com/kyb/companies/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

require 'uri'
require 'net/http'

url = URI("https://ivs.idenfy.com/kyb/companies/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

using RestSharp;


var options = new RestClientOptions("https://ivs.idenfy.com/kyb/companies/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Basic <encoded-value>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ivs.idenfy.com/kyb/companies/{id}/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://ivs.idenfy.com/kyb/companies/{id}/")
  .get()
  .addHeader("Authorization", "Basic <encoded-value>")
  .build()

val response = client.newCall(request).execute()

import Foundation

let url = URL(string: "https://ivs.idenfy.com/kyb/companies/{id}/")!
var request = URLRequest(url: url)
request.httpMethod = "GET"
request.timeoutInterval = 10
request.allHTTPHeaderFields = ["Authorization": "Basic <encoded-value>"]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

200

{
  "id": "<string>",
  "company": {
    "companyName": "<string>",
    "additionalInfo": {},
    "registrationNumber": "<string>",
    "region": "<string>",
    "type": "<string>",
    "phone": "<string>",
    "website": "<string>",
    "email": "[e-mail]",
    "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": "[e-mail]"
    },
    "assignedTo": {
      "id": 123,
      "name": "<string>",
      "surname": "<string>",
      "email": "[e-mail]"
    },
    "blacklistStatuses": [
      {
        "id": "<string>"
      }
    ],
    "sanctionsStatusSetBy": {
      "id": 123,
      "name": "<string>",
      "surname": "<string>",
      "email": "[e-mail]"
    },
    "newsStatusSetBy": {
      "id": 123,
      "name": "<string>",
      "surname": "<string>",
      "email": "[e-mail]"
    },
    "initialSubmissionTime": "2023-11-07T05:31:56Z",
    "submissionTime": "2023-11-07T05:31:56Z",
    "matchedBlacklists": [
      "<string>"
    ],
    "automationFlags": [
      "<string>"
    ],
    "automationStatuses": {},
    "automationRanAt": "2023-11-07T05:31:56Z",
    "sanctionsStatusSetAt": "2023-11-07T05:31:56Z",
    "amlComment": "<string>",
    "newsStatusSetAt": "2023-11-07T05:31:56Z",
    "negativeNewsComment": "<string>",
    "approvalStatusChangedAt": "2023-11-07T05:31:56Z",
    "denyReason": "<string>",
    "informationRequested": true,
    "reviewLevel": "<string>",
    "soleProprietor": true
  },
  "documents": [
    {
      "created": "2023-11-07T05:31:56Z",
      "file": "<string>"
    }
  ],
  "beneficiaries": [
    {
      "id": "<string>",
      "info": {
        "name": "<string>",
        "surname": "<string>",
        "email": "[e-mail]",
        "phone": "<string>",
        "dateOfBirth": "2023-12-25",
        "documentNumber": "<string>",
        "personalNumber": "<string>",
        "residentialAddress": "<string>",
        "postcode": "<string>",
        "address": "<string>",
        "street": "<string>",
        "city": "<string>",
        "tin": "<string>",
        "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": "[e-mail]"
        },
        "sanctionsStatusSetBy": {
          "id": 123,
          "name": "<string>",
          "surname": "<string>",
          "email": "[e-mail]"
        },
        "newsStatusSetBy": {
          "id": 123,
          "name": "<string>",
          "surname": "<string>",
          "email": "[e-mail]"
        },
        "pepsStatusSetAt": "2023-11-07T05:31:56Z",
        "sanctionsStatusSetAt": "2023-11-07T05:31:56Z",
        "amlComment": "<string>",
        "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",
        "input": {
          "fullName": "<string>",
          "dateOfBirth": "2023-12-25"
        },
        "filter": {
          "threshold": 85,
          "datasets": [],
          "sanctionBodies": [
            40
          ],
          "dateOfBirthMatching": "EXACT",
          "pepTiers": []
        },
        "amlCheck": [
          {
            "resourceId": "<string>",
            "score": 123,
            "match": "<string>",
            "name": "<string>",
            "addresses": [
              {
                "geography": "<string>",
                "city": "<string>"
              }
            ],
            "nationalities": [],
            "datesOfBirth": [
              "<string>"
            ],
            "datasets": [],
            "currentSanBodyIds": [
              123
            ],
            "formerSanBodyIds": [
              123
            ],
            "version": 123,
            "profileImage": "<string>"
          }
        ],
        "adverseMedia": [
          {
            "title": "<string>",
            "url": "<string>",
            "text": "<string>",
            "score": 123,
            "type": "NEGATIVE",
            "publishDate": "2023-12-25"
          }
        ],
        "monitoring": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created": "2023-11-07T05:31:56Z",
          "isSubscribed": true,
          "expiration": "2023-11-07T05:31:56Z",
          "tags": []
        }
      },
      "amlMonitoringUser": {
        "monitoringId": "<string>"
      },
      "beneficiaryTypes": [],
      "positions": [],
      "formFiller": true,
      "ownershipPercentage": 50,
      "documents": []
    }
  ],
  "questionnaires": [
    {
      "title": "<string>",
      "sections": [
        {
          "title": "<string>",
          "questions": [
            {
              "key": "<string>",
              "title": "<string>",
              "value": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "comments": [
    {
      "created": "2023-11-07T05:31:56Z",
      "content": "<string>",
      "manager": {
        "id": 123,
        "name": "<string>",
        "surname": "<string>",
        "email": "[e-mail]"
      }
    }
  ],
  "auditLogs": {
    "logs": [
      {
        "identifier": "<string>",
        "text": "<string>",
        "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,
    "addressAuditImages": [
      {
        "image": "<string>"
      }
    ]
  },
  "websiteAudit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "url": "<string>",
    "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": [
        {
          "systemValue": "<string>",
          "reportValue": "<string>"
        }
      ],
      "created": "2023-11-07T05:31:56Z",
      "reportId": "<string>"
    }
  ],
  "einVerification": {
    "checkedEin": "<string>",
    "checkedCompanyName": "<string>",
    "created": "2023-11-07T05:31:56Z"
  },
  "govChecks": {
    "creditBureauDocuments": [
      {
        "id": "<string>",
        "externalCompanyId": "<string>",
        "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",
        "file": "<string>",
        "beneficiaryDocument": true
      }
    ],
    "sosFilingDocuments": [
      {
        "id": "<string>",
        "checkedAt": "2023-11-07T05:31:56Z",
        "dataFile": "<string>",
        "reportFile": "<string>",
        "companyName": "<string>",
        "formationDate": "2023-12-25",
        "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",
    "input": {
      "companyName": "<string>"
    },
    "filter": {
      "threshold": 85,
      "datasets": [],
      "sanctionBodies": [
        40
      ]
    },
    "amlCheck": [
      {
        "resourceId": "<string>",
        "score": 123,
        "match": "<string>",
        "name": "<string>",
        "addresses": [
          {
            "geography": "<string>",
            "city": "<string>"
          }
        ],
        "datasets": [],
        "currentSanBodyIds": [
          123
        ],
        "formerSanBodyIds": [
          123
        ],
        "version": 123
      }
    ],
    "adverseMedia": [
      {
        "title": "<string>",
        "url": "<string>",
        "text": "<string>",
        "score": 123,
        "type": "NEGATIVE",
        "publishDate": "2023-12-25"
      }
    ],
    "monitoring": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "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",
      "input": {
        "fullName": "<string>",
        "dateOfBirth": "2023-12-25"
      },
      "filter": {
        "threshold": 85,
        "datasets": [],
        "sanctionBodies": [
          40
        ],
        "dateOfBirthMatching": "EXACT",
        "pepTiers": []
      },
      "amlCheck": [
        {
          "resourceId": "<string>",
          "score": 123,
          "match": "<string>",
          "name": "<string>",
          "addresses": [
            {
              "geography": "<string>",
              "city": "<string>"
            }
          ],
          "nationalities": [],
          "datesOfBirth": [
            "<string>"
          ],
          "datasets": [],
          "currentSanBodyIds": [
            123
          ],
          "formerSanBodyIds": [
            123
          ],
          "version": 123,
          "profileImage": "<string>"
        }
      ],
      "adverseMedia": [
        {
          "title": "<string>",
          "url": "<string>",
          "text": "<string>",
          "score": 123,
          "type": "NEGATIVE",
          "publishDate": "2023-12-25"
        }
      ],
      "monitoring": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created": "2023-11-07T05:31:56Z",
        "isSubscribed": true,
        "expiration": "2023-11-07T05:31:56Z",
        "tags": []
      }
    }
  ],
  "amlMonitoringUsers": [
    {
      "monitoringId": "<string>",
      "name": "<string>",
      "surname": "<string>",
      "lastCheckDate": "2023-12-25"
    }
  ]
}

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 · read-only

company · object · required

Show child attributes

meta · object · required

Show child attributes

documents · object[] · required

Show child attributes

beneficiaries · object[] · required

Show child attributes

questionnaires · object[] · required

Show child attributes

comments · object[] · required

Show child attributes

auditLogs · object · required

Show child attributes

addressAudit · object · required

Show child attributes

websiteAudit · object · required

Show child attributes

companyNameAudit · object · required

Show child attributes

dataMatchings · object[] · required

Show child attributes

einVerification · object · required

Show child attributes

govChecks · object · required

Show child attributes

amlCheck · object | null · required

Show child attributes

amlChecks · object[] · required

Other AML checks that were performed for this company.

Option 1

Option 2

Show child attributes

amlMonitoringUsers · object[] | null · required

Show child attributes