GET https://api.icomplykyc.com/api/v2/entities?type=legal-entities
Retrieve a list of Legal Entities associated with your account
| Name | Type | Description |
|---|---|---|
|
limit |
Int |
Defines how many entities to return. Max value: 100. Default value: 10 |
|
type |
String |
Defines entity type. Expected values: all, natural-persons, legal-entities. Default value: all |
|
start |
Int |
Defines how many entities to jump over. Default value: 0 |
|
descending |
Boolean |
Defines whether to sort entities in ascending or descending. |
|
supportingDocuments |
Boolean |
Specify whether to return supporting documents for the legal entity. |
|
corporateVerification |
Boolean |
Specify whether to return verification information for this Legal Entity. |
{
"code": 200,
"status": "success",
"message": "",
"data": [
{
"id": "d9c66022-d01b-44f2-8ff4-7d4369923668",
"type": "Legal Entity",
"corporateInformation": {
"companyName": "New Company",
"registrationNumber": "111112",
"dateofIncorporation": "2019-01-02",
"duns": "000000",
"glei": "000000",
"companyPhone": null,
"email": "andrew@testing.com",
"primaryAddress": "123 Fake st",
"city": "Fake City",
"stateProvince": "Beograd",
"country": "CA",
"postalCode": "87333"
}
},
{
"id": "6b3g0d25-6f21-449e-af04-bbeber35fbe9",
"type": "Legal Entity",
"corporateInformation": {
"companyName": "Test Inc.",
"registrationNumber": "123456678",
"dateofIncorporation": null,
"duns": "3423489234",
"glei": "665557778",
"companyPhone": "6045559999",
"email": "matt@macbook.com",
"primaryAddress": "Guran 444",
"city": "Ruege",
"stateProvince": "French Southern Territories",
"country": "CA",
"postalCode": "787645"
},
"corporateVerifications": [
{
"id": "a9bee36a-7f3b-4c8f-a4dd-6aa15bda5dfe",
"legalEntityVerification": true,
"verificationStatus": "Accepted",
"verificationDate": "2022-01-28",
"verificationSource": "Manual Entry",
"businessStatement": "Doing a new demo",
"nextReviewDate": "2023-01-28",
"verificationIssues": []
}
],
"supportingDocuments": []
}
]
}{
// Response
}GET https://api.icomplykyc.com/api/v2/entities/legal-entities/:id
Get the details of the legal entity record by its entity ID
Authentication Type: Api Key
Sample Query: https://api.icomplykyc.com/api/v2/legal-entities/12e34567-fcff-4c10-9dd3-da74422e1c30
| Name | Type | Description |
|---|---|---|
|
id |
String |
The ID of the legal entity |
{
"code": 200,
"status": "success",
"message": "",
"data": {
"kybMetaData": {
"entityID": "1234567d-0e47-4079-8b01-353af8b0ef33",
"createdDateTime": "2020-12-04",
"lastUpdate": null,
"nextKYCReview": "2022-12-04",
"kycStatus": "New",
"externalID": "Starbucks555",
"tags": []
},
"corporateInformation": {
"companyName": "Starbucks Coffee Company",
"alsoKnownAs": [
"Starbucks",
"Starbucks Coffee"
],
"doingBusinessAs": "Starbucks|Starbucks Coffee",
"formerlyKnownAs": [
"Seattle's Starbucks"
],
"registrationNumber": "1234-3456-980",
"dateofIncorporation": "1971-03-30",
"jurisdictionOfIncorporation": "USA",
"jurisdictionOfDomicile": "USA",
"jurisdictionOfTaxResidence": "CYM",
"duns": "150483782",
"glei": "5299019D9BIL4D4UHT93",
"companyPhone": "555-242-0123",
"email": "777 Columbia St",
"primaryAddress": "777 Columbia St",
"city": "New Westminster",
"stateProvince": null,
"country": "CAN",
"postalCode": "V3M 1B6",
"linkedEntities": [
{
"relationship": "Officer",
"entityID": "04831052-235e-4de5-be35-eb9c4ddb33e4"
},
{
"relationship": "Advisor",
"entityID": "018cf32c-f4bc-4217-a797-493b729a3ae9"
}
],
"primaryContactId": "079e0b23-d084-413d-afd2-a215fad7e9e5",
"primaryContactFirstName": "John",
"primaryContactLastName": "Doe",
"primaryContactTitle": null,
"primaryContactPhone": null,
"primaryPhone": null
},
"corporateVerification": [
{
"id": "1234567d-1bfb-49f2-b5ee-04e01ead834b",
"legalEntityVerification": true,
"verificationStatus": "Pending",
"verificationDate": "2020-12-04",
"verificationSource": "DUNS",
"businessStatement": null,
"nextReviewDate": "2022-12-04",
"verificationIssues": []
}
],
"supportingDocuments": {
"supportDocs": true,
"docsPending": [],
"docsReview": [],
"docsAccepted": []
},
"amlScreening": [
{
"id": 589,
"ongoing": false,
"screenDate": "2020-12-04",
"nextReview": "2022-12-04",
"searchTerm": "John Doe",
"searchTypes": [
"person"
],
"searchFuzziness": 40,
"searchCoverage": [
"Warning",
"Pep Class 1"
],
"pending": 17,
"accepted": 0,
"unknown": 0,
"sanctions": 0,
"politicalExposure": 0,
"adverseMedia": 0,
"linkedEntityIds": [
"1234567d-0e47-4079-8b01-353af8b0ef33"
]
}
]
}
}{
"code": 400,
"status": "failure",
"message": "wrong entity type",
"data": null
}{
"code": 404,
"status": "failure",
"message": "there is no legal entity with given id",
"data": null
}GET https://api.icomplykyc.com/api/v2/entities/legal-entities
Search for legal entities by various parameters.
Authentication Type: API Key
Sample Query: https://api.icomplykyc.com/api/v2/legal-entities?duns=150483782&glei=5299019D9BIL4D4UHT93&companyName=Starbucks Coffee Company
| Name | Type | Description |
|---|---|---|
|
externalID |
String |
External ID of the Legal Entity |
|
duns |
Int |
DUNS Number of the Legal Entity |
|
glei |
String |
GLEI Number of the Legal Entity |
|
companyName |
String |
Company Name of the Legal Entity |
|
registrationNumber |
String |
Corporate Registration Number of the Legal Entity |
|
|
String |
Email address associated with the primary contact of the legal entity |
|
phone |
String |
Phone number associated with the legal entity |
{
"code": 200,
"status": "success",
"message": "",
"data": [
"1234567-cd5f-4985-9175-c50ecc21f010"
]
}GET https://api.icomplykyc.com/api/v2/entities/legal-entities/{entityID}/request-client-update
Sends an e-mail to the primary contact for this Legal Entity and requests updated information or supporting documents about this Legal Entity.
Sample Request Body
{
"recepientId": "string",
"emailSubject": "string",
"emailMessage": "string",
"configId": 0, "domain":
"string"
}
{
// Response
}To create a new Legal Entity, initiate a POST request to https://api.icomplykyc.com/api/v2/entities/legal-entities with the following JSON payload.
{
"kybMetaData": {
"kycStatus": "new",
"externalID": "Starbucks555"
},
"kycServices": {
"requestCIV": true,
"requestAML": true
},
"corporateInformation": {
"companyName": "Starbucks Coffee Company",
"alsoKnownAs": ["Starbucks", "Starbucks Coffee"],
"doingBusinessAs": "Starbucks",
"formerlyKnownAs": ["Seattle's Starbucks"],
"registrationNumber": "1234-3456-980",
"dateofIncorporation": "1971-03-30",
"jurisdictionOfIncorporation": "US",
"jurisdictionOfDomicile": "US",
"jurisdictionOfTaxResidence": "KY",
"duns": "150483782",
"glei": "5299019D9BIL4D4UHT93",
"companyPhone": "555-010-0123",
"primaryAddress": "777 Columbia St",
"city": "New Westminster",
"stateProvince": "BC",
"country": "CA",
"postalCode": "V3M 1B6",
"linkedEntities": [
{
"relationship": "Advisor",
"entityId": "018cf32c-f4bc-4217-a797-493b729a3ae9"
},
{
"relationship": "Officer",
"entityId": "04831052-235e-4de5-be35-eb9c4ddb33e4"
}
],
"email": "johndoe@gmail.com",
"primaryContactFirstName": "John",
"primaryContactLastName": "Doe",
"primaryPhone": "555-242-0123",
"primaryContactPhone": "555-313-0123"
},
"corporateVerification": {
"verificationStatus": "pending",
"verificationDate": "2020-09-25",
"verificationSource": "DUNS",
"businessStatement": "To establish Starbucks as the premier purveyor of the finest coffee in the world while maintaining our uncompromising principles while we grow.",
"nextReviewDate": "2022-09-25"
},
"amlScreening": {
"ongoing": false,
"searchTerm": {
"name": "John Doe",
"yearOfBirth": 1969,
"countries": ["US"]
},
"searchType": "person",
"searchFuzziness": 40,
"searchCoverage": ["sanctions", "warning", "pep-class-1"],
"linkedEntityIds": ["018cf32c-f4bc-4217-a797-493b729a3ae9", "04831052-235e-4de5-be35-eb9c4ddb33e4"]
}
}POST https://api.icomplykyc.com/api/v2/entities/legal-entities
Authentication Type: API Key
Sample Query: https://api.icomplykyc.com/api/v2/entities/legal-entities
| Name | Type | Description |
|---|---|---|
|
Raw* |
JSON |
See above sample payload bod |
{
"code": 201,
"status": "success",
"message": "legal entity was successfully created",
"data": {
"id": "368bf475-3c52-4f6f-a057-ba0a2346e546"
},
"errors": []
}400: Bad Request
{
"code": 400,
"status": "failure",
"message": "legal entity could not be created",
"data": null,
"errors": [
"Company name is missing"
]
}409: Conflict
{
"code": 409,
"status": "failure",
"message": "there is already registered organization with given name and duns number",
"data": null
}