Entities

Retrieve a list of Entities associated with your KYC portal instance.

GetEntities

GET https://api.icomplykyc.com/api/v2/entities

Retrieve a list of Entities that have been verified or are waiting for verification

Authentication Type: Api Key

Example Query: https://api.icomplykyc.com/api/v2/entities?limit=10&start=0&descending=true&type=all&identityVerification=true&kycMetaData=true&amlSearches=true&supportingDocuments=true&addresses=true&corporateVerification=true&documentAuthentication=true&biometrics=true

Query Parameters

Name	Type	Description
limit	Int	Defines how many IDs to return. Max value: 100. Default value: 10
start	Int	Defines how many entities to jump over. Default value: 0
descending	Boolean	Defines whether to sort entities in ascending or descending
type	String	Defines entity type. Expected values: all, natural-persons, legal-entities. Default value: all
identityVerification	Boolean	Affects natural persons only
kycMetaData	Boolean	Affects all entities
amlSearches	Boolean	Affects all entities
supportingDocuments	Boolean	Affects all entities
addresses	Boolean	Affects legal entities only
corporateVerification	Boolean	Affects legal entities only
documentAuthentication	Boolean	Affects natural persons only
biometrics	Boolean	Affects natural persons only

200: OK A list of entities and their verification details

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        {
            "id": "123456a-fa38-4893-a88c-bca96ba20cf2",
            "type": "Natural Person",
            "kycMetaData": {
                "assignedUser": null,
                "dateCreated": "2022-02-02 13:29:30.9211175",
                "riskLevel": 0,
                "status": "New",
                "lastUpdated": "2022-02-02 13:39:39.4233256"
            },
            "personalInformation": {
                "firstName": "John",
                "middleName": null,
                "lastName": "Doe",
                "dateOfBirth": "1966-01-09",
                "phone": "01234567896",
                "email": "[e-mail]",
                "city": "Greenwich",
                "stateProvince": "London, City of",
                "countryCode": "GB",
                "postalCode": "123 5FR",
                "address": null
            },
            "biometrics": [
                {
                    "id": "123456a-fa38-4893-a88c-bca96ba20cf2",
                    "dateAdded": "02-02-2022",
                    "queryId": 1234567890,
                    "type": "Live Face Match",
                    "status": "Review",
                    "duration": 26417,
                    "faceMatchResult": true,
                    "livenessResult": true
                }
            ],
            "identityVerification": [
                {
                    "id": "123456a-fa38-4893-a88c-bca96ba20cf2",
                    "identityVerification": true,
                    "identityStatus": "Review",
                    "identityIssues": [],
                    "dataSources": "https://trade.globalblock.co.uk",
                    "nextReviewDate": "2023-02-02"
                }
            ],
            "documentAuthentication": [
                {
                    "id": "123456a-fa38-4893-a88c-bca96ba20cf2",
                    "queryId": 1234567890,
                    "dateAdded": "2022-02-02",
                    "docType": "Passport",
                    "docNumber": "12345678",
                    "docIssues": [
                        "The Month of Birth located does not match the Month of Birth submitted"
                    ],
                    "docExpiryDate": "2026-07-10"
                }
            ],
            "supportingDocuments": [],
            "amlSearches": []
        },
        {
            "id": "123456aab-f84f-43b5-88b1-0c6a14536528",
            "type": "Natural Person",
            "kycMetaData": {
                "assignedUser": null,
                "dateCreated": "2022-01-29 23:42:02.5508689",
                "riskLevel": 0,
                "status": "New",
                "lastUpdated": "2022-01-29 23:47:41.5740869"
            },
            "personalInformation": {
                "firstName": "Jane",
                "middleName": null,
                "lastName": "Doe",
                "dateOfBirth": "1993-03-01",
                "phone": "4161234567",
                "email": "[e-mail]",
                "city": "Toronto",
                "stateProvince": "Ontario",
                "countryCode": "CA",
                "postalCode": "M6B 3Y5",
                "address": null
            },
            "biometrics": [
                {
                    "id": "123456a-fa38-4893-a88c-bca96ba20cf2",
                    "dateAdded": "29-01-2022",
                    "queryId": 1234567890,
                    "type": "Live Face Match",
                    "status": "Accepted",
                    "duration": 15538,
                    "faceMatchResult": false,
                    "livenessResult": true
                }
            ],
            "identityVerification": [
                {
                    "id": "123456a-fa38-4893-a88c-bca96ba20cf2",
                    "identityVerification": true,
                    "identityStatus": "Accepted",
                    "identityIssues": [],
                    "dataSources": "https://trade.chainmyne.com",
                    "nextReviewDate": "2023-01-29"
                }
            ],
            "documentAuthentication": [
                {
                    "id": "123456a-fa38-4893-a88c-bca96ba20cf2",
                    "queryId": 1234567890,
                    "dateAdded": "2022-01-29",
                    "docType": "Passport",
                    "docNumber": null,
                    "docIssues": [],
                    "docExpiryDate": "0001-01-01"
                }
            ],
            "supportingDocuments": [],
            "amlSearches": [
                {
                    "searchTerm": "Jane Doe",
                    "date": "2022-02-01",
                    "id": 6153,
                    "potential": 1,
                    "unknown": 0,
                    "rejected": 0,
                    "accepted": 0
                }
            ]
        }
    ]
}

401: Unauthorized Unauthorized request

400: Bad Request Returned if invalid parameters are passed

GetEntityIDs

GET https://api.icomplykyc.com/api/v2/entities/identifiers

Retrieve a list of entity IDs associated with your account. These entity IDs can be used to get more information about a specific entity.

Authentication Type: Api Key

Example Query: https://api.icomplykyc.com/api/v2/entities/identifiers?limit=100&start=0&descending=true&type=all

Query Parameters

Name	Type	Description
limit	Int	Defines how many IDs to return. Max value: 1000. Default value: 100
start	Int	Defines how many entities to jump over. Default value: 0
descending	Boolean	Defines whether to sort entities in ascending or descending
type	String	Defines entity type. Expected values: all, natural-persons, legal-entities. Default value: all

200: OK

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": [
        "1234567a-fb38-4893-a88c-bca96ba20bd2",
        "1234567a-294c-4178-a45e-466a17b18dca",
        "1234567a-b000-4279-95a6-b1e7d24bbd88",
        "1234567a-b5e6-4fe2-9310-4a2dd1849819",
        "1234567a-aee7-46cc-b9b1-9ce08c6b3a0c",
        "1234567a-b4bb-460b-9bf0-13bec025885c"
    ]
}

401: Unauthorized Unauthorized

400: Bad Request Returned if parameter values are malformed