{ "swagger": "2.0", "info": { "title": "KYC API v2", "version": "1.0" }, "host": "api-demo.knowyourcustomer.com", "basePath": "/v2", "schemes": [ "https" ], "securityDefinitions": { "apiKeyHeader": { "type": "apiKey", "name": "Ocp-Apim-Subscription-Key", "in": "header" }, "apiKeyQuery": { "type": "apiKey", "name": "subscription-key", "in": "query" } }, "security": [ { "apiKeyHeader": [] }, { "apiKeyQuery": [] } ], "x-servers": [ { "url": "https://api-demo.knowyourcustomer.com" }, { "url": "https://kycdemoapimanagementservice-uksouth-01.regional.azure-api.net" } ], "paths": { "/verification/chinaId": { "post": { "description": "Verifies chinese individual", "operationId": "597b372afe9cef0db4739712", "summary": "China ID Verification", "parameters": [ { "name": "chinaBody", "in": "body", "schema": { "$ref": "#/definitions/ChinaBody" } } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/ChinaVerificationResult" }, "examples": { "application/json": { "verified": true, "message": "ID and name are consistent with police ID database" } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } } }, "produces": [ "application/json" ] } }, "/companies/{caseCommonId}": { "get": { "description": "Gets company case details", "operationId": "597b372afe9cef0db473970c", "summary": "Company Details", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "Case Common identifier", "required": true, "type": "number" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns company case details\r\n\r\ncommon - case common object:\r\n- caseCommonId - company case identifier in Know Your Customer web application;\r\n- caseCustomerId - identifier of the company case for related customer;\r\n- type - case common type code.\r\n- typeString - case common type name. Text representation of the type;\r\n- complete - indicates percentage of case automatic verification process completion;\r\n- edit - deprecated field;\r\n- status - current status of the company case, representing the case has been manually\r\nclosed by a user or not. Can be \"Open\" or \"Closed\";\r\n- statusId - represents current state of the case. Available status identifiers see in the table below.\r\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\r\n- isVisible - indicates if the company case is visible in Know Your Customer web\r\n- isAMLCase - indicates should we check on anti money laundering only or not;\r\n- countryRisk - anti money laundering country risk score;\r\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\r\n\r\nisCaseAMLPositive - True if the case contains at least one AML check not excluded. False otherwise\r\n\r\ncompany - case company object:\r\n- caseCompanyId - company identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- type - type of business entity;\r\n- properties - object which can contain different set of data depending from jurisdiction and registry. Each registry provides different set of data.\r\n\r\ncaseAddress - case address object:\r\n- caseAddressId - case address identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- rawAddress - address received from registry;\r\n- address - normalized address;\r\n\r\nAvailable case common status identifiers:\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n

statusId

\r\n
\r\n

Meaning

\r\n
\r\n

Applies to what Cases

\r\n
\r\n

Description

\r\n
\r\n

0

\r\n
\r\n

Initializing

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

\"Initializing Case\" (immediately after case created)

\r\n
\r\n

1

\r\n
\r\n

Data Collection

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

Data Collection is being performed for the case (either manually or automated) the case is considerred on hold until, an automatic or manual intervention gets done

\r\n
\r\n

2

\r\n
\r\n

Data Verification

\r\n
\r\n

\r\n

Companies and Individuals

\r\n

\r\n
\r\n

The Case is being verified for Data accuracy, integrity & quality

\r\n
\r\n

3

\r\n
\r\n

Ready

\r\n
\r\n

Companies and Individuals

\r\n\r\n
\r\n

\"Ready\" (When our automatic processes are finished and all sub-cases are also ready and the user can now work on the case)

\r\n
\r\n

4-49

\r\n
\r\n

Reserved

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

-

\r\n
\r\n

50

\r\n
\r\n

RetrievingBasicData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving basic company data\" (when we get status, registered address etc.)

\r\n
\r\n

51

\r\n
\r\n

IdentifyingControllingEntities

\r\n
\r\n

Companies

\r\n
\r\n

\"Identifying controlling entities\" (when we scan for director information)

\r\n
\r\n

52

\r\n
\r\n

RetrievingExtendedData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving extended company data, if available

\r\n
\r\n

53

\r\n
\r\n

DownloadingCompanyDocuments

\r\n
\r\n

Companies

\r\n
\r\n

\"Downloading company documents\" (while documents are being downloaded and classified)

\r\n
\r\n

54

\r\n
\r\n

IdentifyingBeneficialOwners

\r\n
\r\n

Companies

\r\n
\r\n

Identifying beneficial owners\" (by using OCR, Data Extraction or Machine Learning Techniques)

\r\n
\r\n

55

\r\n
\r\n

PreparingChildren

\r\n
\r\n

Companies

\r\n
\r\n

Preparing sub-case\" (when this case is ready but some parent company shareholder or corporate secretary/director was found and we are waiting for that sub-case to finish)

\r\n
\r\n

56

\r\n
\r\n

CheckingListedEntities

\r\n
\r\n

Companies

\r\n
\r\n

Checking for market listed entities

\r\n
\r\n

57-99

\r\n
\r\n

Reserved

\r\n
\r\n

Companies

\r\n
\r\n\r\n

 

\r\n
\r\n

100

\r\n
\r\n

PerformingAmlChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual AML Checks

\r\n
\r\n

101

\r\n
\r\n

PerformingAddressChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Address Checks in available Jurisdictions

\r\n
\r\n

102

\r\n
\r\n

PerformingCourtChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Courts Data Checks in available Jurisdictions

\r\n
\r\n

103-150

\r\n
\r\n

Reserved

\r\n
\r\n

Individuals

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n", "schema": { "$ref": "#/definitions/CaseDetailResult" }, "examples": { "application/json": { "caseDetail": { "details": { "common": { "caseCommonId": 7839, "caseCustomerId": 677, "customerId": 224, "customerName": "YourCustomer", "type": 1, "typeString": "Company", "scoring": 0, "complete": 55, "edit": true, "status": "Open", "statusChangedDatetime": null, "statusChangedBy": null, "statusId": 3, "caseDecision": "Accepted", "isVisible": true, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorUserName": "example@example.com", "createdDatetime": "2017-09-26T05:22:52.847", "updatedBySystem": "2017-09-26T05:26:11.41", "isAMLCase": false, "updatedByUser": null, "customerDepartmentId": 1249, "customerDepartmentName": "Management", "countryRisk": 5.51, "assignedUserId": null, "assignedUserName": null, "link": "https://app.knowyourcustomer.com/casecompany/7839/detail" }, "isCaseAMLPositive": true, "company": { "id": 3080, "caseCompanyId": 3080, "caseCommonId": 7839, "countryCodeISO31662": "HK", "entityName": "HKTC Corporate Services Limited", "type": "Private company limited by shares", "description": "Checking for Company Situation", "userId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "createdDatetime": "2017-09-26T05:22:52.893", "properties": { "Company Status": "Active", "Company Type": "Private company limited by shares", "Incorporation Date": "16/08/2012", "Other Names": "香港企業諮詢服務有限公司" } }, "caseAddress": { "caseAddressId": 7792, "caseCommonId": 7839, "addressLine1": "40-44 Wyndham Place Wyndham Street Central", "addressLine2": "", "city": "Hong Kong", "stateProvince": null, "postcode": null, "country": "Hong kong", "countryCodeISO31662": "HK", "countryId": 3, "rawAddress": "6/F., WYNDHAM PLACE,40-44 WYNDHAM STREET, CENTRAL, HONG KONG, HONG KONG", "address": "40-44 Wyndham Place Wyndham Street Central, Hong Kong, Hong kong", "userId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorName": "example@example.com", "createdDatetime": "2017-09-26T05:22:52.893" } } } } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/{caseCommonId}/documents": { "get": { "description": "Gets company documents", "operationId": "597b372afe9cef0db4739710", "summary": "Company Documents", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "Case Common identifier", "required": true, "type": "number" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns case documents structure.\r\ndocuments - object which contains grouped documents for requested case and sub-cases (child cases).\r\nEach sub-case can contain own documents object which includes documents related to this one sub-case. Sub-cases are grouped by sections.", "schema": { "$ref": "#/definitions/CompanyDocumentsResult" }, "examples": { "application/json": { "caseCommonId": 4166, "name": "AUTOPOINT ACCESSORIES LIMITED", "documents": { "Company Identity Documents": [ { "link": "https://kyc.azure-api.net/v2/documents/3368", "category": "Certificate", "name": "Certificate <26/01/2007>" } ], "Other Company Documents": [ { "link": "https://kyc.azure-api.net/v2/documents/3369", "category": "COMPANY CONSTITUTION", "name": "COMPANY CONSTITUTION <26/01/2007>" }, { "link": "https://kyc.azure-api.net/v2/documents/3366", "category": "Company Print Out", "name": "Company Print Out" } ] }, "controllingEntitiesAndIndividuals": [ { "caseCommonId": 4167, "name": "James Crowley", "documents": {} } ], "shareholdersAndBeneficialOwners": [ { "caseCommonId": 4167, "name": "James Crowley", "documents": {} } ] } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/{caseCommonId}/members": { "get": { "description": "Gets company case members. Know Your Customer application supports two types of cases:\r\n- Company case - a case created for company that should be verified;\r\n- Individual case - a case created for individual for verification against AML worldcheck database, government photo id, etc.\r\n\r\nBoth types of cases can be members of the parent company case (can be officers and/or shareholders).", "operationId": "59a71a2efe9cef13f4a647f4", "summary": "Company Members", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "Case Common identifier", "required": true, "type": "number" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Company members structure.\r\n
\r\nAll returned member groups (controllingEntitiesAndIndividuals and shareholdersAndBeneficialOwners) can include cases for individuals and companies.\r\nEach returned member group got title which is represented by controllingEntitiesAndIndividualsTitle and shareholdersAndBeneficialOwnersTitle properties. These properties describe what kind of members the current group contains (\"Controlling Entities and Individuals\", \"Partners and Beneficial Owners\", etc).\r\n
\r\n\r\nEach member result object contains:\r\n- properties - object which can contain different set of data depending from jurisdiction and registry. Each registry provides different set of data.\r\n
Minimum dataset for company member: Company Name, Company Type,\r\n Company Registration Number, Company Status, Creation / Incorporation Date.\r\n
Minimum dataset for individual member: Individual Name, Individual Relation (Director | Secretary | Auditor | etc).\r\n\r\n- isCaseAMLPositive - True if the case contains at least one AML check not excluded. False otherwise;\r\n- isKYCed - indicates if the particular member can be processed and verified;\r\n- memberType - type of the member. Can be \"Company\" or \"Individual\".\r\n", "schema": { "$ref": "#/definitions/CaseMembersResult" }, "examples": { "application/json": { "controllingEntitiesAndIndividualsTitle": "Controlling Entities and Individuals", "controllingEntitiesAndIndividuals": [ { "role": "Partner", "isCaseAMLPositive": false, "member": { "firstName": "Dan", "lastName": "Linddal Bechmann ANDERSEN", "caseCommonId": 14150, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "38 C Søndre Alle", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Alle 38 C , Rønne, 3700 Rønne, Denmark", "address": "38 C Søndre Alle, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Partner", "isCaseAMLPositive": false, "member": { "entityName": "AKTK ApS", "caseCommonId": 14151, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "12 Store Torvegade", "addressLine2": "", "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Store Torvegade 12, 3700 Rønne", "address": "12 Store Torvegade, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": { "Company Type": "Private company limited by shares", "Company Status": "Active", "Creation Date": "27/08/2012", "Registration Number": "34692394", "Other Names": "ALLINGE REVISION ApS; ALLINGE REVISIONSKONTOR ApS; CENTRUM REVISION ApS" } }, "memberType": "Company", "isKYCed": true }, { "role": "Partner", "isCaseAMLPositive": false, "member": { "firstName": "Ivan", "lastName": "Søren QVIST", "caseCommonId": 14152, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "2 A Elses Løkkevej", "addressLine2": null, "city": "Nexø", "stateProvince": null, "postcode": "3730", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark", "address": "2 A Elses Løkkevej, Nexø, 3730, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Partner", "isCaseAMLPositive": false, "member": { "firstName": "Ole", "lastName": "BONDERUP", "caseCommonId": 14153, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "1 Broløkke", "addressLine2": null, "city": "Svaneke", "stateProvince": null, "postcode": "3740", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Broløkke 1 , Østermarie, 3740 Svaneke, Denmark", "address": "1 Broløkke, Svaneke, 3740, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Partner", "isCaseAMLPositive": false, "member": { "firstName": "Anders", "lastName": "KOFOED", "caseCommonId": 14154, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "94 Aaker", "addressLine2": null, "city": "Aakirkeby", "stateProvince": null, "postcode": "3720", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark", "address": "94 Aaker, Aakirkeby, 3720, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Partner", "isCaseAMLPositive": false, "member": { "firstName": "Tonny", "lastName": "KOFOED", "caseCommonId": 14155, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "37 Kapelvej", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Kapelvej 37 , Rønne, 3700 Rønne, Denmark", "address": "37 Kapelvej, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Director", "isCaseAMLPositive": false, "member": { "firstName": "Dan", "lastName": "Linddal Bechmann ANDERSEN", "caseCommonId": 14150, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "38 C Søndre Alle", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Alle 38 C , Rønne, 3700 Rønne, Denmark", "address": "38 C Søndre Alle, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Director", "isCaseAMLPositive": false, "member": { "entityName": "AKTK ApS", "caseCommonId": 14151, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "12 Store Torvegade", "addressLine2": "", "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Store Torvegade 12, 3700 Rønne", "address": "12 Store Torvegade, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": { "Company Type": "Private company limited by shares", "Company Status": "Active", "Creation Date": "27/08/2012", "Registration Number": "34692394", "Other Names": "ALLINGE REVISION ApS; ALLINGE REVISIONSKONTOR ApS; CENTRUM REVISION ApS" } }, "memberType": "Company", "isKYCed": true }, { "role": "Director", "isCaseAMLPositive": false, "member": { "firstName": "Ivan", "lastName": "Søren QVIST", "caseCommonId": 14152, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "2 A Elses Løkkevej", "addressLine2": null, "city": "Nexø", "stateProvince": null, "postcode": "3730", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark", "address": "2 A Elses Løkkevej, Nexø, 3730, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false }, { "role": "Director", "isCaseAMLPositive": false, "member": { "firstName": "Ole", "lastName": "BONDERUP", "caseCommonId": 14153, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "1 Broløkke", "addressLine2": null, "city": "Svaneke", "stateProvince": null, "postcode": "3740", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Broløkke 1 , Østermarie, 3740 Svaneke, Denmark", "address": "1 Broløkke, Svaneke, 3740, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false }, { "role": "Director", "isCaseAMLPositive": false, "member": { "firstName": "Anders", "lastName": "KOFOED", "caseCommonId": 14154, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "94 Aaker", "addressLine2": null, "city": "Aakirkeby", "stateProvince": null, "postcode": "3720", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark", "address": "94 Aaker, Aakirkeby, 3720, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false }, { "role": "Director", "isCaseAMLPositive": false, "member": { "firstName": "Tonny", "lastName": "KOFOED", "caseCommonId": 14155, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "37 Kapelvej", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Kapelvej 37 , Rønne, 3700 Rønne, Denmark", "address": "37 Kapelvej, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false } ], "shareholdersAndBeneficialOwnersTitle": "Partners and Beneficial Owners", "shareholdersAndBeneficialOwners": [ { "shares": 27, "isCaseAMLPositive": false, "member": { "firstName": "Anders", "lastName": "KOFOED", "caseCommonId": 14154, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "94 Aaker", "addressLine2": null, "city": "Aakirkeby", "stateProvince": null, "postcode": "3720", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark", "address": "94 Aaker, Aakirkeby, 3720, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "shares": 27, "isCaseAMLPositive": false, "member": { "firstName": "Tonny", "lastName": "KOFOED", "caseCommonId": 14155, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "37 Kapelvej", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Kapelvej 37 , Rønne, 3700 Rønne, Denmark", "address": "37 Kapelvej, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "shares": 0, "isCaseAMLPositive": false, "member": { "firstName": "Dan", "lastName": "Linddal Bechmann ANDERSEN", "caseCommonId": 14150, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "38 C Søndre Alle", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Alle 38 C , Rønne, 3700 Rønne, Denmark", "address": "38 C Søndre Alle, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false }, { "shares": 0, "isCaseAMLPositive": false, "member": { "entityName": "AKTK ApS", "caseCommonId": 14151, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "12 Store Torvegade", "addressLine2": "", "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Store Torvegade 12, 3700 Rønne", "address": "12 Store Torvegade, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": { "Company Type": "Private company limited by shares", "Company Status": "Active", "Creation Date": "27/08/2012", "Registration Number": "34692394", "Other Names": "ALLINGE REVISION ApS; ALLINGE REVISIONSKONTOR ApS; CENTRUM REVISION ApS" } }, "memberType": "Company", "isKYCed": false }, { "shares": 0, "isCaseAMLPositive": false, "member": { "firstName": "Ivan", "lastName": "Søren QVIST", "caseCommonId": 14152, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "2 A Elses Løkkevej", "addressLine2": null, "city": "Nexø", "stateProvince": null, "postcode": "3730", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark", "address": "2 A Elses Løkkevej, Nexø, 3730, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false }, { "shares": 0, "isCaseAMLPositive": false, "member": { "firstName": "Ole", "lastName": "BONDERUP", "caseCommonId": 14153, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "1 Broløkke", "addressLine2": null, "city": "Svaneke", "stateProvince": null, "postcode": "3740", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Broløkke 1 , Østermarie, 3740 Svaneke, Denmark", "address": "1 Broløkke, Svaneke, 3740, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false } ] } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies": { "post": { "description": "Creates a new company case", "operationId": "597b372afe9cef0db473970f", "summary": "Create Company Case", "parameters": [ { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "createCaseBody", "in": "body", "schema": { "$ref": "#/definitions/CreateCaseBody" }, "description": "Company data.\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n
NameDescriptionMandatory
rawnameCompany nameYes
externalCodeCompany registration numberNo
codeiso31662Country ISO 3166-2 codeYes
entityType\r\n Company type. Allowance values: Company,\r\n Partnership and Trust. (Obsolete, this parameter will be removed in the future.)\r\n Yes (for not automated jurisdictions)
journeyNameName of the journeyNo
companyType\r\n Company type. Allowance values: get from /companytypes\r\n Yes (for not automated jurisdictions)
\r\nAutomated jurisdictions. It means we are able to perform search in the registries of these particular jurisdictions. If you get response with code 400 (Bad Reqeust) and error description \"Invalid Jurisdiction\" it means the particular jurisdiction is not automated yet." } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Return created company case details:\r\n\r\ncommon - case common object:\r\n- caseCommonId - newly created company case identifier in Know Your Customer web application;\r\n- caseCustomerId - identifier of the company case for related customer;\r\n- type - case common type code.\r\n- typeString - case common type name. Text representation of the type. Can be \"Company\" or \"Individual\";\r\n- complete - indicates percentage of case automatic verification process completion;\r\n-edit - deprecated field;\r\n- status - current status of the company case, representing the case has been manually \r\nclosed by a user or not. Can be \"Open\" or \"Closed\";\r\n- statusId - representing current state of the case. Available status identifiers see in the table below.\r\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\r\n- isVisible - indicates if the company case is visible in Know Your Customer web \r\n- isAMLCase - indicates should we check on anti money laundering only or not;\r\n- countryRisk - anti money laundering country risk score;\r\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\r\n\r\ncompany - case company object:\r\n- caseCompanyId - company identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- type - type of business entity;\r\n- properties - object which can contain different set of data depending from jurisdiction and registry. Will be empty for this operation.\r\n\r\ncaseAddress - case address object:\r\n- caseAddressId - case address identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- rawAddress - address received from registry;\r\n- address - normalized address;\r\n\r\nAvailable case common status identifiers:\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n

statusId

\r\n
\r\n

Meaning

\r\n
\r\n

Applies to what Cases

\r\n
\r\n

Description

\r\n
\r\n

0

\r\n
\r\n

Initializing

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

\"Initializing Case\" (immediately after case created)

\r\n
\r\n

1

\r\n
\r\n

Data Collection

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

Data Collection is being performed for the case (either manually or automated) the case is considerred on hold until, an automatic or manual intervention gets done

\r\n
\r\n

2

\r\n
\r\n

Data Verification

\r\n
\r\n

\r\n

Companies and Individuals

\r\n

\r\n
\r\n

The Case is being verified for Data accuracy, integrity & quality

\r\n
\r\n

3

\r\n
\r\n

Ready

\r\n
\r\n

Companies and Individuals

\r\n\r\n
\r\n

\"Ready\" (When our automatic processes are finished and all sub-cases are also ready and the user can now work on the case)

\r\n
\r\n

4-49

\r\n
\r\n

Reserved

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

-

\r\n
\r\n

50

\r\n
\r\n

RetrievingBasicData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving basic company data\" (when we get status, registered address etc.)

\r\n
\r\n

51

\r\n
\r\n

IdentifyingControllingEntities

\r\n
\r\n

Companies

\r\n
\r\n

\"Identifying controlling entities\" (when we scan for director information)

\r\n
\r\n

52

\r\n
\r\n

RetrievingExtendedData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving extended company data, if available

\r\n
\r\n

53

\r\n
\r\n

DownloadingCompanyDocuments

\r\n
\r\n

Companies

\r\n
\r\n

\"Downloading company documents\" (while documents are being downloaded and classified)

\r\n
\r\n

54

\r\n
\r\n

IdentifyingBeneficialOwners

\r\n
\r\n

Companies

\r\n
\r\n

Identifying beneficial owners\" (by using OCR, Data Extraction or Machine Learning Techniques)

\r\n
\r\n

55

\r\n
\r\n

PreparingChildren

\r\n
\r\n

Companies

\r\n
\r\n

Preparing sub-case\" (when this case is ready but some parent company shareholder or corporate secretary/director was found and we are waiting for that sub-case to finish)

\r\n
\r\n

56

\r\n
\r\n

CheckingListedEntities

\r\n
\r\n

Companies

\r\n
\r\n

Checking for market listed entities

\r\n
\r\n

57-99

\r\n
\r\n

Reserved

\r\n
\r\n

Companies

\r\n
\r\n\r\n

 

\r\n
\r\n

100

\r\n
\r\n

PerformingAmlChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual AML Checks

\r\n
\r\n

101

\r\n
\r\n

PerformingAddressChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Address Checks in available Jurisdictions

\r\n
\r\n

102

\r\n
\r\n

PerformingCourtChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Courts Data Checks in available Jurisdictions

\r\n
\r\n

103-150

\r\n
\r\n

Reserved

\r\n
\r\n

Individuals

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
", "schema": { "$ref": "#/definitions/CaseDetailResult" }, "examples": { "application/json": { "caseDetail": { "details": { "common": { "caseCommonId": 10001, "caseCustomerId": 889, "customerId": 224, "customerName": "YourCustomer", "type": 1, "typeString": "Company", "scoring": 0, "complete": 0, "edit": true, "status": "Open", "statusChangedDatetime": null, "statusChangedBy": null, "statusId": 0, "caseDecision": null, "isVisible": true, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorUserName": "example@example.com", "createdDatetime": "2017-10-20T21:30:53.863", "updatedBySystem": null, "isAMLCase": false, "updatedByUser": null, "customerDepartmentId": 1249, "customerDepartmentName": "Management", "countryRisk": 4.77, "assignedUserId": null, "assignedUserName": null, "link": "https://app.knowyourcustomer.com/casecompany/10001/detail" }, "company": { "id": 3777, "caseCompanyId": 3777, "caseCommonId": 10001, "countryCodeISO31662": "GB", "entityName": "TEST AIR SERVICES LTD", "type": null, "description": "Case Generated from API2", "userId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "createdDatetime": "2017-10-20T21:30:54.09", "properties": {} }, "caseAddress": { "caseAddressId": 9950, "caseCommonId": 10001, "addressLine1": null, "addressLine2": null, "city": null, "stateProvince": null, "postcode": null, "country": null, "countryCodeISO31662": null, "countryId": null, "rawAddress": null, "address": null, "userId": null, "creatorName": null, "createdDatetime": "2017-10-20T21:30:54.093" } } } } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Internal Error", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] }, "get": { "description": "Gets companies list", "operationId": "5bdab77bbbb05c65307047e3", "summary": "Companies", "parameters": [ { "name": "createdDateFrom", "in": "query", "description": "Start time at which the case was created in ISO 8601 format (YYYY-MM-DDThh:mm:ss)", "type": "string" }, { "name": "createdDateTo", "in": "query", "description": "End time at which the case was created in ISO 8601 format (YYYY-MM-DDThh:mm:ss)", "type": "string" }, { "name": "countryCodeIso31662", "in": "query", "description": "ISO 31662 country code for which the cases should belong", "type": "string" }, { "name": "pageSize", "in": "query", "description": "Size of the page", "type": "string" }, { "name": "pageNumber", "in": "query", "description": "Page number", "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Return array of companies cases.\r\n\r\ncommon - case common object:\r\n- caseCommonId - company case identifier in Know Your Customer web application;\r\n- caseCustomerId - identifier of the company case for related customer;\r\n- type - case common type code.\r\n- typeString - case common type name. Text representation of the type;\r\n- complete - indicates percentage of case automatic verification process completion;\r\n- edit - deprecated field;\r\n- status - current status of the company case, representing the case has been manually\r\nclosed by a user or not. Can be \"Open\" or \"Closed\";\r\n- statusId - represents current state of the case. Available status identifiers see in the table below.\r\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\r\n- isVisible - indicates if the company case is visible in Know Your Customer web\r\n- isAMLCase - indicates should we check on anti money laundering only or not;\r\n- countryRisk - anti money laundering country risk score;\r\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\r\n\r\nisCaseAMLPositive - True if the case contains at least one AML check not excluded. False otherwise\r\n\r\ncompany - case company object:\r\n- caseCompanyId - company identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- type - type of business entity;\r\n- properties - object which can contain different set of data depending from jurisdiction and registry. Each registry provides different set of data.\r\n\r\ncaseAddress - case address object:\r\n- caseAddressId - case address identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- rawAddress - address received from registry;\r\n- address - normalized address;\r\n\r\nAvailable case common status identifiers:\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n

statusId

\r\n
\r\n

Meaning

\r\n
\r\n

Applies to what Cases

\r\n
\r\n

Description

\r\n
\r\n

0

\r\n
\r\n

Initializing

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

\"Initializing Case\" (immediately after case created)

\r\n
\r\n

1

\r\n
\r\n

Data Collection

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

Data Collection is being performed for the case (either manually or automated) the case is considerred on hold until, an automatic or manual intervention gets done

\r\n
\r\n

2

\r\n
\r\n

Data Verification

\r\n
\r\n

\r\n

Companies and Individuals

\r\n

\r\n
\r\n

The Case is being verified for Data accuracy, integrity & quality

\r\n
\r\n

3

\r\n
\r\n

Ready

\r\n
\r\n

Companies and Individuals

\r\n\r\n
\r\n

\"Ready\" (When our automatic processes are finished and all sub-cases are also ready and the user can now work on the case)

\r\n
\r\n

4-49

\r\n
\r\n

Reserved

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

-

\r\n
\r\n

50

\r\n
\r\n

RetrievingBasicData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving basic company data\" (when we get status, registered address etc.)

\r\n
\r\n

51

\r\n
\r\n

IdentifyingControllingEntities

\r\n
\r\n

Companies

\r\n
\r\n

\"Identifying controlling entities\" (when we scan for director information)

\r\n
\r\n

52

\r\n
\r\n

RetrievingExtendedData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving extended company data, if available

\r\n
\r\n

53

\r\n
\r\n

DownloadingCompanyDocuments

\r\n
\r\n

Companies

\r\n
\r\n

\"Downloading company documents\" (while documents are being downloaded and classified)

\r\n
\r\n

54

\r\n
\r\n

IdentifyingBeneficialOwners

\r\n
\r\n

Companies

\r\n
\r\n

Identifying beneficial owners\" (by using OCR, Data Extraction or Machine Learning Techniques)

\r\n
\r\n

55

\r\n
\r\n

PreparingChildren

\r\n
\r\n

Companies

\r\n
\r\n

Preparing sub-case\" (when this case is ready but some parent company shareholder or corporate secretary/director was found and we are waiting for that sub-case to finish)

\r\n
\r\n

56

\r\n
\r\n

CheckingListedEntities

\r\n
\r\n

Companies

\r\n
\r\n

Checking for market listed entities

\r\n
\r\n

57-99

\r\n
\r\n

Reserved

\r\n
\r\n

Companies

\r\n
\r\n\r\n

 

\r\n
\r\n

100

\r\n
\r\n

PerformingAmlChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual AML Checks

\r\n
\r\n

101

\r\n
\r\n

PerformingAddressChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Address Checks in available Jurisdictions

\r\n
\r\n

102

\r\n
\r\n

PerformingCourtChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Courts Data Checks in available Jurisdictions

\r\n
\r\n

103-150

\r\n
\r\n

Reserved

\r\n
\r\n

Individuals

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n", "schema": { "$ref": "#/definitions/CompaniesList" }, "examples": { "application/json": "[{\r\n\t\"common\": {\r\n \"caseCommonId\": 7839,\r\n \"caseCustomerId\": 677,\r\n \"customerId\": 224,\r\n \"customerName\": \"YourCustomer\",\r\n \"type\": 1,\r\n \"typeString\": \"Company\",\r\n \"scoring\": 0,\r\n \"complete\": 55,\r\n \"edit\": true,\r\n \"status\": \"Open\",\r\n \"statusChangedDatetime\": null,\r\n \"statusChangedBy\": null,\r\n \"statusId\": 3,\r\n \"caseDecision\": \"Accepted\",\r\n \"isVisible\": true,\r\n \"creatorId\": \"db557fed-99b5-4c8a-b3c9-5d2d42d2bc13\",\r\n \"creatorUserName\": \"example@example.com\",\r\n \"createdDatetime\": \"2017-09-26T05:22:52.847\",\r\n \"updatedBySystem\": \"2017-09-26T05:26:11.41\",\r\n \"isAMLCase\": false,\r\n \"updatedByUser\": null,\r\n \"customerDepartmentId\": 1249,\r\n \"customerDepartmentName\": \"Management\",\r\n \"countryRisk\": 5.51,\r\n \"assignedUserId\": null,\r\n \"assignedUserName\": null,\r\n \"link\": \"https://app.knowyourcustomer.com/casecompany/7839/detail\"\r\n },\r\n \"isCaseAMLPositive\": true,\r\n \"company\": {\r\n \"id\": 3080,\r\n \"caseCompanyId\": 3080,\r\n \"caseCommonId\": 7839,\r\n \"countryCodeISO31662\": \"HK\",\r\n \"entityName\": \"HKTC Corporate Services Limited\",\r\n \"type\": \"Private company limited by shares\",\r\n \"description\": \"Checking for Company Situation\",\r\n \"userId\": \"db557fed-99b5-4c8a-b3c9-5d2d42d2bc13\",\r\n \"creatorId\": \"db557fed-99b5-4c8a-b3c9-5d2d42d2bc13\",\r\n \"createdDatetime\": \"2017-09-26T05:22:52.893\",\r\n \"properties\": {\r\n \"Company Status\": \"Active\",\r\n \"Company Type\": \"Private company limited by shares\",\r\n \"Incorporation Date\": \"16/08/2012\",\r\n \"Other Names\": \"香港企業諮詢服務有限公司\"\r\n }\r\n },\r\n \"caseAddress\": {\r\n \"caseAddressId\": 7792,\r\n \"caseCommonId\": 7839,\r\n \"addressLine1\": \"40-44 Wyndham Place Wyndham Street Central\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Hong Kong\",\r\n \"stateProvince\": null,\r\n \"postcode\": null,\r\n \"country\": \"Hong kong\",\r\n \"countryCodeISO31662\": \"HK\",\r\n \"countryId\": 3,\r\n \"rawAddress\": \"6/F., WYNDHAM PLACE,40-44 WYNDHAM STREET, CENTRAL, HONG KONG, HONG KONG\",\r\n \"address\": \"40-44 Wyndham Place Wyndham Street Central, Hong Kong, Hong kong\",\r\n \"userId\": \"db557fed-99b5-4c8a-b3c9-5d2d42d2bc13\",\r\n \"creatorName\": \"example@example.com\",\r\n \"createdDatetime\": \"2017-09-26T05:22:52.893\"\r\n }\r\n}]\r\n" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/documents/{documentId}": { "get": { "description": "Download Document", "operationId": "597b372afe9cef0db4739711", "summary": "Download Document", "parameters": [ { "name": "documentId", "in": "path", "description": "Document id", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Document data" }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } } }, "produces": [ "application/json" ] } }, "/jurisdictions": { "get": { "description": "Get available jurisdictions", "operationId": "597b372afe9cef0db473970e", "summary": "Jurisdictions", "parameters": [ { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns list of the available jurisdictions", "schema": { "$ref": "#/definitions/JurisdictionsResult" }, "examples": { "application/json": { "jurisdictions": { "jurisdiction": [ { "name": "Ireland", "codeiso31662": "IE", "area": "Europe", "isautomated": true }, { "name": "United kingdom", "codeiso31662": "GB", "area": "Europe", "isautomated": true }, { "name": "Czech republic", "codeiso31662": "CZ", "area": "Europe", "isautomated": false } ] } } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid API Key", "timeStamp": "7/28/2017 2:15:51 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/search": { "post": { "description": "Executes companies search in the registry of the specified jurisdiciton based on:\r\n- country code defined in ISO 3166-2 standard;\r\n- search query (full or partial company name or company registration number).\r\n\r\nCompanies search working only for automated jurisdictions. It means we are able to perform search in the registries of these particular jurisdictions. If you get response with code 400 (Bad Reqeust) and error description \"Invalid Jurisdiction\" it means the particular jurisdiction is not automated yet.", "operationId": "597b372afe9cef0db473970d", "summary": "Search Companies", "parameters": [ { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "caseSearchBody", "in": "body", "schema": { "$ref": "#/definitions/CaseSearchBody" }, "description": "Parameters definition:\r\n- codeiso31662 - jurisdiction's country code defined in ISO 3166-2 standard;\r\n- query - full or partial name or registration number of the company you are looking for." } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Returns companies list based on search criteria:\r\n- rawname - actual company name or trade name provided by registry site;\r\n- externalCode - company registration number provided by registry site;\r\n- rawAddress - company address provided by registry site.", "schema": { "$ref": "#/definitions/CompaniesSearchResult" }, "examples": { "application/json": { "companySearch": { "results": [ { "rawname": "TEST AIR SERVICES LTD", "externalCode": "06650586", "rawAddress": "96 96 Pelhurst Road, Ryde, Isle Of Wight, England" }, { "rawname": "TEST AIR SOLUTIONS LIMITED", "externalCode": "05661420", "rawAddress": "225 Market Street, Hyde, Cheshire, SK14 1HF" } ] } } } }, "400": { "description": "Invalid request parameters. Errors descriptions:\r\n- Invalid Jurisdiction - provided jurisdiction is not automated yet. You cannot perform companies search for not automated jurisdictions.", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid Jurisdiction", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/verification/identity": { "post": { "description": "Verifies uploaded passport document without performing First Name / Last Name / Birth Date comparison and returns a verification report.\r\n\r\nFinal verification result can be accessed from success or triggeredRule property. Properties are described in the response schema.", "operationId": "597b372afe9cef0db4739713", "summary": "Verify Identity", "parameters": [ { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "file", "in": "formData", "description": "Passport image", "type": "string" } ], "consumes": [ "multipart/form-data" ], "responses": { "200": { "description": "Identity verification result", "schema": { "$ref": "#/definitions/VerificationIdentityResult" }, "examples": { "application/json": { "success": false, "message": null, "triggeredRule": { "scenario": "#8", "result": "Fail", "message": "DocumentIsExpired", "sensitivity": "Low", "decision": "Expired", "properties": { "failUpload": false } }, "imageQuality": { "percentage": 71, "value": "High" }, "forgeryTests": [ { "group": "Data Integrity", "type": "Check Sum - Date of Birth", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Check Sum - Date of Expiry", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Check Sum - Document Number", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Check Sum - General", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Check Sum - Optional Data", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Data Comparison - Date of Birth", "result": "NotRelevant" }, { "group": "Data Integrity", "type": "Data Comparison - Expiry Date", "result": "NotRelevant" }, { "group": "Data Integrity", "type": "Data Comparison - Last Name", "result": "Unconclusive" }, { "group": "Data Integrity", "type": "Validation - MRZ Date of Birth", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Validation - MRZ Date of Expiry", "result": "Authenticated" }, { "group": "Digital", "type": "Photo Replacement", "result": "Authenticated" }, { "group": "Digital", "type": "Text Replacement", "result": "NotRelevant" }, { "group": "Structure", "type": "Complete MRZ", "result": "Authenticated" }, { "group": "Structure", "type": "MRZ Fonts - Alphabetic", "result": "NotRelevant" }, { "group": "Structure", "type": "MRZ Fonts - Digits", "result": "Authenticated" } ], "identityReport": { "firstName": "KEVIN RICHARD", "lastName": "HALLIGEN", "birthDate": "1961-07-14T00:00:00", "sourceDocument": "Passport", "birthPlace": null, "expiryDate": "2012-02-13T00:00:00", "documentNumber": "S196082", "address": null } } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid API Key", "timeStamp": "7/28/2017 2:15:51 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/version": { "get": { "description": "Get current API version.", "operationId": "597b3729fe9cef0db473970b", "summary": "Version", "parameters": [ { "name": "ApiKey", "in": "header", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "examples": { "application/json": "\"2.0.1.23013\"" } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } } }, "produces": [ "application/json" ] } }, "/individuals": { "post": { "description": "Creates a new individual case", "operationId": "5a181acf1257bc13c421bd17", "summary": "Create Individual Case", "parameters": [ { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "createIndividualCaseBody", "in": "body", "schema": { "$ref": "#/definitions/CreateIndividualCaseBody" }, "description": "Individual data.\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n \r\n
NameDescriptionMandatory
firstNameThe First NameYes
lastNameThe Family NameYes
nationalityCodeiso31662Nationality Country ISO 3166-2 codeNo
birthDateThe Date of Birth (Format: dd/mm/yyyy)No
addressLine1Address Line 1No
addressLine2Address Line 2No
postcodeThe postcodeNo
cityThe cityNo
provinceThe state/provinceNo
countryCodeiso31662Address Country ISO 3166-2 codeNo
propertiesArray of the individual properties, has same request body structure as described at the POST /individuals/caseCommonId/properties endpointNo
journeyNameName of the jounrneyNo
" } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Return created individual case details:\r\n\r\ncommon - case common object:\r\n- caseCommonId - individual case identifier in Know Your Customer web application;\r\n- caseCustomerId - identifier of the individual case for related customer;\r\n- type - case common type code.\r\n- typeString - case common type name. Text representation of the type;\r\n- complete - indicates percentage of case automatic verification process completion;\r\n- edit - deprecated field;\r\n- status - current status of the individual case, representing the case has been manually \r\nclosed by a user or not. Can be \"Open\" or \"Closed\";\r\n- statusId - representing current state of the case. Available status identifiers see in the table below.\r\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\r\n- isVisible - indicates if the individual case is visible in Know Your Customer web \r\n- isAMLCase - indicates should we check on anti money laundering only or not;\r\n- countryRisk - anti money laundering country risk score;\r\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\r\n\r\nindividual - case individual object:\r\n- caseIndividualId - individual identifier in Know Your Customer web application;\r\n- firstName - individual's first name;\r\n- lastName - individual's last name;\r\n- countryCodeISO31662 - country code of individual case defined in ISO 3166-2 standard;\r\n- nationalityCodeISO31662 - country code of the nationality defined in ISO 3166-2 standard;\r\n- properties - object which can contain different set of data like Date of Birth, Occupdation, etc;\r\n\r\ncaseAddress - case address object:\r\n- caseAddressId - case address identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- rawAddress - address received from registry;\r\n- address - normalized address;\r\n\r\nAvailable case common status identifiers:\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n

statusId

\r\n
\r\n

Meaning

\r\n
\r\n

Applies to what Cases

\r\n
\r\n

Description

\r\n
\r\n

0

\r\n
\r\n

Initializing

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

\"Initializing Case\" (immediately after case created)

\r\n
\r\n

1

\r\n
\r\n

Data Collection

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

Data Collection is being performed for the case (either manually or automated) the case is considerred on hold until, an automatic or manual intervention gets done

\r\n
\r\n

2

\r\n
\r\n

Data Verification

\r\n
\r\n

\r\n

Companies and Individuals

\r\n

\r\n
\r\n

The Case is being verified for Data accuracy, integrity & quality

\r\n
\r\n

3

\r\n
\r\n

Ready

\r\n
\r\n

Companies and Individuals

\r\n\r\n
\r\n

\"Ready\" (When our automatic processes are finished and all sub-cases are also ready and the user can now work on the case)

\r\n
\r\n

4-49

\r\n
\r\n

Reserved

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

-

\r\n
\r\n

50

\r\n
\r\n

RetrievingBasicData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving basic company data\" (when we get status, registered address etc.)

\r\n
\r\n

51

\r\n
\r\n

IdentifyingControllingEntities

\r\n
\r\n

Companies

\r\n
\r\n

\"Identifying controlling entities\" (when we scan for director information)

\r\n
\r\n

52

\r\n
\r\n

RetrievingExtendedData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving extended company data, if available

\r\n
\r\n

53

\r\n
\r\n

DownloadingCompanyDocuments

\r\n
\r\n

Companies

\r\n
\r\n

\"Downloading company documents\" (while documents are being downloaded and classified)

\r\n
\r\n

54

\r\n
\r\n

IdentifyingBeneficialOwners

\r\n
\r\n

Companies

\r\n
\r\n

Identifying beneficial owners\" (by using OCR, Data Extraction or Machine Learning Techniques)

\r\n
\r\n

55

\r\n
\r\n

PreparingChildren

\r\n
\r\n

Companies

\r\n
\r\n

Preparing sub-case\" (when this case is ready but some parent company shareholder or corporate secretary/director was found and we are waiting for that sub-case to finish)

\r\n
\r\n

56

\r\n
\r\n

CheckingListedEntities

\r\n
\r\n

Companies

\r\n
\r\n

Checking for market listed entities

\r\n
\r\n

57-99

\r\n
\r\n

Reserved

\r\n
\r\n

Companies

\r\n
\r\n\r\n

 

\r\n
\r\n

100

\r\n
\r\n

PerformingAmlChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual AML Checks

\r\n
\r\n

101

\r\n
\r\n

PerformingAddressChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Address Checks in available Jurisdictions

\r\n
\r\n

102

\r\n
\r\n

PerformingCourtChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Courts Data Checks in available Jurisdictions

\r\n
\r\n

103-150

\r\n
\r\n

Reserved

\r\n
\r\n

Individuals

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
", "schema": { "$ref": "#/definitions/IndividualCaseDetailResult" }, "examples": { "application/json": { "caseDetail": { "details": { "individual": { "caseIndividualId": 8905, "firstName": "John", "lastName": "Doe", "countryCodeISO31662": "PT", "country": "Portugal", "email": null, "phone": null, "nationalityCountryCodeISO31662": "GB", "nationalityCountry": "United kingdom", "caseCommonId": 14050, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "properties": { "Birth Date": "01/01/1990" }, "createdDatetime": "2017-11-24T11:44:17.22" }, "common": { "caseCommonId": 14069, "caseCustomerId": 1165, "customerId": 224, "customerName": "AndreiCo", "type": 2, "typeString": "Individual", "scoring": 0, "complete": 0, "edit": true, "status": "Open", "statusChangedDatetime": null, "statusChangedBy": null, "statusId": null, "caseDecision": null, "isVisible": true, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorUserName": "avgybarev@gmail.com", "createdDatetime": "2017-11-24T13:41:58.03", "updatedBySystem": null, "isAMLCase": null, "updatedByUser": null, "customerDepartmentId": 1249, "customerDepartmentName": "Management", "countryRisk": 4.77, "assignedUserId": null, "assignedUserName": null, "link": "https://dev.knowyourcustomer.com/caseindividual/14069/detail" }, "caseAddress": { "caseAddressId": 7792, "caseCommonId": 7839, "addressLine1": "40-44 Wyndham Place Wyndham Street Central", "addressLine2": "", "city": "Hong Kong", "stateProvince": null, "postcode": null, "country": "Hong kong", "countryCodeISO31662": "HK", "countryId": 3, "rawAddress": "6/F., WYNDHAM PLACE,40-44 WYNDHAM STREET, CENTRAL, HONG KONG, HONG KONG", "address": "40-44 Wyndham Place Wyndham Street Central, Hong Kong, Hong kong", "userId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorName": "example@example.com", "createdDatetime": "2017-09-26T05:22:52.893" } } } } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Internal Error", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] }, "get": { "description": "Gets individuals list", "operationId": "5bdacf5a13f9403fd9df848b", "summary": "Individuals", "parameters": [ { "name": "createdDateFrom", "in": "query", "description": "Start time at which the case was created in ISO 8601 format (YYYY-MM-DDThh:mm:ss)", "type": "string" }, { "name": "createdDateTo", "in": "query", "description": "End time at which the case was created in ISO 8601 format (YYYY-MM-DDThh:mm:ss)", "type": "string" }, { "name": "countryCodeIso31662", "in": "query", "description": "ISO 31662 country code for which the cases should belong", "type": "string" }, { "name": "pageSize", "in": "query", "description": "Size of the page", "type": "string" }, { "name": "pageNumber", "in": "query", "description": "Page number", "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns list of individual cases.\r\n\r\ncommon - case common object:\r\n- caseCommonId - individual case identifier in Know Your Customer web application;\r\n- caseCustomerId - identifier of the individual case for related customer;\r\n- type - case common type code.\r\n- typeString - case common type name. Text representation of the type;\r\n- complete - indicates percentage of case automatic verification process completion;\r\n- edit - deprecated field;\r\n- status - current status of the individual case, representing the case has been manually \r\nclosed by a user or not. Can be \"Open\" or \"Closed\";\r\n- statusId - representing current state of the case. Available status identifiers see in the table below.\r\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\r\n- isVisible - indicates if the individual case is visible in Know Your Customer web \r\n- isAMLCase - indicates should we check on anti money laundering only or not;\r\n- countryRisk - anti money laundering country risk score;\r\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\r\n\r\nisCaseAMLPositive - True if the case contains at least one AML check not excluded. False otherwise\r\n\r\nindividual - case individual object:\r\n- caseIndividualId - individual identifier in Know Your Customer web application;\r\n- firstName - individual's first name;\r\n- lastName - individual's last name;\r\n- countryCodeISO31662 - country code of individual case defined in ISO 3166-2 standard;\r\n- nationalityCodeISO31662 - country code of the nationality defined in ISO 3166-2 standard;\r\n- properties - object which can contain different set of data like Date of Birth, Occupdation, etc;\r\n\r\ncaseAddress - case address object:\r\n- caseAddressId - case address identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- rawAddress - address received from registry;\r\n- address - normalized address;\r\n\r\nAvailable case common status identifiers:\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n

statusId

\r\n
\r\n

Meaning

\r\n
\r\n

Applies to what Cases

\r\n
\r\n

Description

\r\n
\r\n

0

\r\n
\r\n

Initializing

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

\"Initializing Case\" (immediately after case created)

\r\n
\r\n

1

\r\n
\r\n

Data Collection

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

Data Collection is being performed for the case (either manually or automated) the case is considerred on hold until, an automatic or manual intervention gets done

\r\n
\r\n

2

\r\n
\r\n

Data Verification

\r\n
\r\n

\r\n

Companies and Individuals

\r\n

\r\n
\r\n

The Case is being verified for Data accuracy, integrity & quality

\r\n
\r\n

3

\r\n
\r\n

Ready

\r\n
\r\n

Companies and Individuals

\r\n\r\n
\r\n

\"Ready\" (When our automatic processes are finished and all sub-cases are also ready and the user can now work on the case)

\r\n
\r\n

4-49

\r\n
\r\n

Reserved

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

-

\r\n
\r\n

50

\r\n
\r\n

RetrievingBasicData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving basic company data\" (when we get status, registered address etc.)

\r\n
\r\n

51

\r\n
\r\n

IdentifyingControllingEntities

\r\n
\r\n

Companies

\r\n
\r\n

\"Identifying controlling entities\" (when we scan for director information)

\r\n
\r\n

52

\r\n
\r\n

RetrievingExtendedData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving extended company data, if available

\r\n
\r\n

53

\r\n
\r\n

DownloadingCompanyDocuments

\r\n
\r\n

Companies

\r\n
\r\n

\"Downloading company documents\" (while documents are being downloaded and classified)

\r\n
\r\n

54

\r\n
\r\n

IdentifyingBeneficialOwners

\r\n
\r\n

Companies

\r\n
\r\n

Identifying beneficial owners\" (by using OCR, Data Extraction or Machine Learning Techniques)

\r\n
\r\n

55

\r\n
\r\n

PreparingChildren

\r\n
\r\n

Companies

\r\n
\r\n

Preparing sub-case\" (when this case is ready but some parent company shareholder or corporate secretary/director was found and we are waiting for that sub-case to finish)

\r\n
\r\n

56

\r\n
\r\n

CheckingListedEntities

\r\n
\r\n

Companies

\r\n
\r\n

Checking for market listed entities

\r\n
\r\n

57-99

\r\n
\r\n

Reserved

\r\n
\r\n

Companies

\r\n
\r\n\r\n

 

\r\n
\r\n

100

\r\n
\r\n

PerformingAmlChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual AML Checks

\r\n
\r\n

101

\r\n
\r\n

PerformingAddressChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Address Checks in available Jurisdictions

\r\n
\r\n

102

\r\n
\r\n

PerformingCourtChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Courts Data Checks in available Jurisdictions

\r\n
\r\n

103-150

\r\n
\r\n

Reserved

\r\n
\r\n

Individuals

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
", "schema": { "$ref": "#/definitions/IndividualsList" }, "examples": { "application/json": "[{\r\n\t\"individual\": {\r\n \"caseIndividualId\": 8905,\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"countryCodeISO31662\": \"PT\",\r\n \"country\": \"Portugal\",\r\n \"email\": null,\r\n \"phone\": null,\r\n \"nationalityCountryCodeISO31662\": \"GB\",\r\n \"nationalityCountry\": \"United kingdom\",\r\n \"caseCommonId\": 14050,\r\n \"creatorId\": \"db557fed-99b5-4c8a-b3c9-5d2d42d2bc13\",\r\n \"properties\": {\r\n \"Birth Date\": \"01/01/1990\"\r\n },\r\n \"createdDatetime\": \"2017-11-24T11:44:17.22\"\r\n },\r\n \"isCaseAMLPositive\": true,\r\n \"common\": {\r\n \"caseCommonId\": 14069,\r\n \"caseCustomerId\": 1165,\r\n \"customerId\": 224,\r\n \"customerName\": \"AndreiCo\",\r\n \"type\": 2,\r\n \"typeString\": \"Individual\",\r\n \"scoring\": 0,\r\n \"complete\": 0,\r\n \"edit\": true,\r\n \"status\": \"Open\",\r\n \"statusChangedDatetime\": null,\r\n \"statusChangedBy\": null,\r\n \"statusId\": null,\r\n \"caseDecision\": \"Accepted\",\r\n \"isVisible\": true,\r\n \"creatorId\": \"db557fed-99b5-4c8a-b3c9-5d2d42d2bc13\",\r\n \"creatorUserName\": \"avgybarev@gmail.com\",\r\n \"createdDatetime\": \"2017-11-24T13:41:58.03\",\r\n \"updatedBySystem\": null,\r\n \"isAMLCase\": null,\r\n \"updatedByUser\": null,\r\n \"customerDepartmentId\": 1249,\r\n \"customerDepartmentName\": \"Management\",\r\n \"countryRisk\": 4.77,\r\n \"assignedUserId\": null,\r\n \"assignedUserName\": null,\r\n \"link\": \"https://dev.knowyourcustomer.com/caseindividual/14069/detail\"\r\n },\r\n \"caseAddress\": {\r\n \"caseAddressId\": 7792,\r\n \"caseCommonId\": 7839,\r\n \"addressLine1\": \"40-44 Wyndham Place Wyndham Street Central\",\r\n \"addressLine2\": \"\",\r\n \"city\": \"Hong Kong\",\r\n \"stateProvince\": null,\r\n \"postcode\": null,\r\n \"country\": \"Hong kong\",\r\n \"countryCodeISO31662\": \"HK\",\r\n \"countryId\": 3,\r\n \"rawAddress\": \"6/F., WYNDHAM PLACE,40-44 WYNDHAM STREET, CENTRAL, HONG KONG, HONG KONG\",\r\n \"address\": \"40-44 Wyndham Place Wyndham Street Central, Hong Kong, Hong kong\",\r\n \"userId\": \"db557fed-99b5-4c8a-b3c9-5d2d42d2bc13\",\r\n \"creatorName\": \"example@example.com\",\r\n \"createdDatetime\": \"2017-09-26T05:22:52.893\"\r\n }\r\n}]\r\n" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/individuals/{caseCommonId}": { "get": { "description": "Gets individual case details", "operationId": "5a180a231257bc13c421bd16", "summary": "Individual Details", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "Case Common identifier", "required": true, "type": "number" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns individual case details\r\n\r\ncommon - case common object:\r\n- caseCommonId - individual case identifier in Know Your Customer web application;\r\n- caseCustomerId - identifier of the individual case for related customer;\r\n- type - case common type code.\r\n- typeString - case common type name. Text representation of the type;\r\n- complete - indicates percentage of case automatic verification process completion;\r\n- edit - deprecated field;\r\n- status - current status of the individual case, representing the case has been manually\r\nclosed by a user or not. Can be \"Open\" or \"Closed\";\r\n- statusId - representing current state of the case. Available status identifiers see in the table below.\r\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\r\n- isVisible - indicates if the individual case is visible in Know Your Customer web\r\n- isAMLCase - indicates should we check on anti money laundering only or not;\r\n- countryRisk - anti money laundering country risk score;\r\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\r\n\r\nisCaseAMLPositive - True if the case contains at least one AML check not excluded. False otherwise\r\n\r\nindividual - case individual object:\r\n- caseIndividualId - individual identifier in Know Your Customer web application;\r\n- firstName - individual's first name;\r\n- lastName - individual's last name;\r\n- countryCodeISO31662 - country code of individual case defined in ISO 3166-2 standard;\r\n- nationalityCodeISO31662 - country code of the nationality defined in ISO 3166-2 standard;\r\n- properties - object which can contain different set of data like Date of Birth, Occupdation, etc;\r\n\r\ncaseAddress - case address object:\r\n- caseAddressId - case address identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- rawAddress - address received from registry;\r\n- address - normalized address;\r\n\r\nAvailable case common status identifiers:\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n

statusId

\r\n
\r\n

Meaning

\r\n
\r\n

Applies to what Cases

\r\n
\r\n

Description

\r\n
\r\n

0

\r\n
\r\n

Initializing

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

\"Initializing Case\" (immediately after case created)

\r\n
\r\n

1

\r\n
\r\n

Data Collection

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

Data Collection is being performed for the case (either manually or automated) the case is considerred on hold until, an automatic or manual intervention gets done

\r\n
\r\n

2

\r\n
\r\n

Data Verification

\r\n
\r\n

\r\n

Companies and Individuals

\r\n

\r\n
\r\n

The Case is being verified for Data accuracy, integrity & quality

\r\n
\r\n

3

\r\n
\r\n

Ready

\r\n
\r\n

Companies and Individuals

\r\n\r\n
\r\n

\"Ready\" (When our automatic processes are finished and all sub-cases are also ready and the user can now work on the case)

\r\n
\r\n

4-49

\r\n
\r\n

Reserved

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

-

\r\n
\r\n

50

\r\n
\r\n

RetrievingBasicData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving basic company data\" (when we get status, registered address etc.)

\r\n
\r\n

51

\r\n
\r\n

IdentifyingControllingEntities

\r\n
\r\n

Companies

\r\n
\r\n

\"Identifying controlling entities\" (when we scan for director information)

\r\n
\r\n

52

\r\n
\r\n

RetrievingExtendedData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving extended company data, if available

\r\n
\r\n

53

\r\n
\r\n

DownloadingCompanyDocuments

\r\n
\r\n

Companies

\r\n
\r\n

\"Downloading company documents\" (while documents are being downloaded and classified)

\r\n
\r\n

54

\r\n
\r\n

IdentifyingBeneficialOwners

\r\n
\r\n

Companies

\r\n
\r\n

Identifying beneficial owners\" (by using OCR, Data Extraction or Machine Learning Techniques)

\r\n
\r\n

55

\r\n
\r\n

PreparingChildren

\r\n
\r\n

Companies

\r\n
\r\n

Preparing sub-case\" (when this case is ready but some parent company shareholder or corporate secretary/director was found and we are waiting for that sub-case to finish)

\r\n
\r\n

56

\r\n
\r\n

CheckingListedEntities

\r\n
\r\n

Companies

\r\n
\r\n

Checking for market listed entities

\r\n
\r\n

57-99

\r\n
\r\n

Reserved

\r\n
\r\n

Companies

\r\n
\r\n\r\n

 

\r\n
\r\n

100

\r\n
\r\n

PerformingAmlChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual AML Checks

\r\n
\r\n

101

\r\n
\r\n

PerformingAddressChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Address Checks in available Jurisdictions

\r\n
\r\n

102

\r\n
\r\n

PerformingCourtChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Courts Data Checks in available Jurisdictions

\r\n
\r\n

103-150

\r\n
\r\n

Reserved

\r\n
\r\n

Individuals

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n", "schema": { "$ref": "#/definitions/IndividualCaseDetailResult" }, "examples": { "application/json": { "caseDetail": { "details": { "individual": { "caseIndividualId": 8905, "firstName": "John", "lastName": "Doe", "countryCodeISO31662": "PT", "country": "Portugal", "email": null, "phone": null, "nationalityCountryCodeISO31662": "GB", "nationalityCountry": "United kingdom", "caseCommonId": 14050, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "properties": { "Birth Date": "01/01/1990" }, "createdDatetime": "2017-11-24T11:44:17.22" }, "isCaseAMLPositive": true, "common": { "caseCommonId": 14069, "caseCustomerId": 1165, "customerId": 224, "customerName": "AndreiCo", "type": 2, "typeString": "Individual", "scoring": 0, "complete": 0, "edit": true, "status": "Open", "statusChangedDatetime": null, "statusChangedBy": null, "statusId": null, "caseDecision": "Accepted", "isVisible": true, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorUserName": "avgybarev@gmail.com", "createdDatetime": "2017-11-24T13:41:58.03", "updatedBySystem": null, "isAMLCase": null, "updatedByUser": null, "customerDepartmentId": 1249, "customerDepartmentName": "Management", "countryRisk": 4.77, "assignedUserId": null, "assignedUserName": null, "link": "https://dev.knowyourcustomer.com/caseindividual/14069/detail" }, "caseAddress": { "caseAddressId": 7792, "caseCommonId": 7839, "addressLine1": "40-44 Wyndham Place Wyndham Street Central", "addressLine2": "", "city": "Hong Kong", "stateProvince": null, "postcode": null, "country": "Hong kong", "countryCodeISO31662": "HK", "countryId": 3, "rawAddress": "6/F., WYNDHAM PLACE,40-44 WYNDHAM STREET, CENTRAL, HONG KONG, HONG KONG", "address": "40-44 Wyndham Place Wyndham Street Central, Hong Kong, Hong kong", "userId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorName": "example@example.com", "createdDatetime": "2017-09-26T05:22:52.893" } } } } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/{caseCommonId}/properties": { "post": { "description": "Creates new company case properties or update existing with same data type and returns array of existing company case properties", "operationId": "5a421c561257bc0ca8459627", "summary": "Create/Update Company Case Properties", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "casePropertiesArrayBodyCompanies", "in": "body", "schema": { "$ref": "#/definitions/CasePropertiesArrayBodyCompanies" }, "description": "Body should contain array of case properties you want to create/update. Case property object contains:\r\n- dataType - case property data type;\r\n- data - case property data.\r\n\r\nYou can create case property with data type existing in the system or new one.\r\n\r\nNote: Please call /properties/dataTypes to get existing data types and reuse them. If you can't find proper data type in existing data types then create case property with new one data type." } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Return all case properties for particular company case.", "schema": { "$ref": "#/definitions/CasePropertiesArrayResult" }, "examples": { "application/json": "[\r\n {\r\n \"dataType\": \"Activity Type\",\r\n \"data\": \"Any type\"\r\n },\r\n {\r\n \"dataType\": \"Other Names\",\r\n \"data\": \"Test Limited\"\r\n }\r\n]" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] }, "get": { "description": "Gets company case properties", "operationId": "5a4219cf1257bc0ca8459625", "summary": "Get Company Case Properties", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns array of company case properties.", "schema": { "$ref": "#/definitions/CasePropertiesArrayResult" }, "examples": { "application/json": "[\r\n {\r\n \"dataType\": \"Other Names\",\r\n \"data\": \"Test Company Limited\"\r\n }\r\n]" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/individuals/{caseCommonId}/properties": { "post": { "description": "Creates new individual case properties or update existing with same data type and returns array of existing individual case properties", "operationId": "5a4220901257bc0ca8459628", "summary": "Create/Update Individual Case Properties", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "casePropertiesArrayBodyIndividual", "in": "body", "schema": { "$ref": "#/definitions/CasePropertiesArrayBodyIndividual" }, "description": "Body should contain array of case properties you want to create/update. Case property object contains:\r\n- dataType - case property data type;\r\n- data - case property data.\r\n\r\nYou can create case property with data type existing in the system or new one.\r\n\r\nNote: Please call /properties/dataTypes to get existing data types and reuse them. If you can't find proper data type in existing data types then create case property with new one data type." } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Return all case properties for particular individual case.", "schema": { "$ref": "#/definitions/CasePropertiesArrayResult" }, "examples": { "application/json": "[\r\n {\r\n \"dataType\": \"Birth Date\",\r\n \"data\": \"01/01/2000\"\r\n }\r\n]" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] }, "get": { "description": "Gets individual case properties", "operationId": "5a421b361257bc0ca8459626", "summary": "Get Individual Case Properties", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns array of individual case properties.", "schema": { "$ref": "#/definitions/CasePropertiesArrayResult" }, "examples": { "application/json": "[\r\n {\r\n \"dataType\": \"Birth Date\",\r\n \"data\": \"01/01/2000\"\r\n }\r\n]" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/properties/dataTypes": { "get": { "description": "Gets distinct data types of case properties existing in the system.", "operationId": "5a4215061257bc0ca8459623", "summary": "Get Data Types", "parameters": [ { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Return distinct datatypes of case properties existing in the system that could be used to create new properties records.", "schema": { "$ref": "#/definitions/DataTypesResult" }, "examples": { "application/json": "[\r\n \"Birth Date\",\r\n \"Nationality\",\r\n \"Creation Date\",\r\n \"Activity Type\",\r\n \"Company Status\",\r\n \"Company Type\",\r\n \"Appointed on\",\r\n \"Occupations\",\r\n \"Registration Number\",\r\n \"Incorporation Date\",\r\n \"Last Accounts Date\",\r\n \"Next Accounts Date\",\r\n \"Records Date\",\r\n \"Date of Incorporation\",\r\n \"Dissolution Date\",\r\n \"Other Names\",\r\n \"National Country ID \",\r\n \"Passport Country\",\r\n \"Passport Number\",\r\n \"National Country ID\",\r\n \"Postal Code\",\r\n \"TradeMark\",\r\n \"Phone\",\r\n \"VAT\",\r\n \"USA State\",\r\n \"Email\",\r\n \"ID / Registration Number\",\r\n \"Name\",\r\n \"Fax Number\",\r\n \"Identity Type\",\r\n \"Capital\",\r\n \"Law\",\r\n \"Other Identifers\",\r\n \"Total Share Capital\",\r\n \"Other Identifiers\"\r\n]" } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/{caseCommonId}/documents/mandatory": { "get": { "description": "Gets mandatory documents for company case", "operationId": "5a4cf0191257bc0f544bda4f", "summary": "Get Mandatory Documents For Company Case", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns array mandatory documents categories", "schema": { "$ref": "#/definitions/DocumentCategories" }, "examples": { "application/json": "[\r\n \"NEWINC\"\r\n]" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/individuals/{caseCommonId}/documents/mandatory": { "get": { "description": "Gets mandatory documents for individual case", "operationId": "5a4cf3c01257bc0f544bda50", "summary": "Get Mandatory Documents For Individual Case", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns array mandatory documents categories", "schema": { "$ref": "#/definitions/DocumentCategories" }, "examples": { "application/json": "[\r\n \"photoid\"\r\n]" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/import": { "post": { "description": "Imports company case", "operationId": "5a5861341257bc0aa819a424", "summary": "Import Company Case", "parameters": [ { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "importCompanyCaseBody", "in": "body", "schema": { "$ref": "#/definitions/ImportCompanyCaseBody" }, "description": "Request body should contain company details you want to import, company properties (optional) and company address. See representation example and request body schema. Below provided description of each property:

\r\nentityName - the company name. Optional field;
\r\ncodeiso31662 - country ISO 3166-2 code. Optional field;
\r\ncompanyType - the company type. See possible values in the list below. Optional field;
\r\nproperties - array of the company properties, has same request body structure as described on POST /companies/caseCommonId/properties endpoint. Optional field;
\r\njourneyName - Name of the journey. Optional field;
\r\naddress - the object described company address. Mandatory field
\r\naddress can include the following properties:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\t\r\n \r\n \r\n \r\n \r\n\t\r\n \r\n \r\n \r\n \r\n\t\r\n \r\n \r\n \r\n \r\n\t\r\n \r\n \r\n \r\n \r\n\t\r\n \r\n \r\n \r\n \r\n\t\r\n \r\n \r\n \r\n \r\n\t\r\n \r\n \r\n \r\n \r\n\t\r\n \r\n \r\n \r\n \r\n \r\n
NameDescriptionMandatory
addressLine1Address Line 1No
addressLine2Address Line 2No
postcodeThe postcodeNo
cityThe cityNo
provinceThe state/provinceNo
codeiso31662Address Country ISO 3166-2 codeYes
typeAddress typeNo
rawAddressNot normalized address stringNo
\r\n\r\nIf the rawAddress is provided then it will be normalized, separated and saved by parts. Otherwise, It will try to save address by provided parts.\r\n\r\nPossible company types:\r\n" } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Return imported company case details:\r\n\r\ncommon - case common object:\r\n- caseCommonId - newly created company case identifier in Know Your Customer web application;\r\n- caseCustomerId - identifier of the company case for related customer;\r\n- type - case common type code.\r\n- typeString - case common type name. Text representation of the type. Can be \"Company\" or \"Individual\";\r\n- complete - indicates percentage of case automatic verification process completion;\r\n-edit - deprecated field;\r\n- status - current status of the company case, representing the case has been manually \r\nclosed by a user or not. Can be \"Open\" or \"Closed\";\r\n- statusId - representing current state of the case. Available status identifiers see in the table below.\r\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\r\n- isVisible - indicates if the company case is visible in Know Your Customer web \r\n- isAMLCase - indicates should we check on anti money laundering only or not;\r\n- countryRisk - anti money laundering country risk score;\r\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\r\n\r\ncompany - case company object:\r\n- caseCompanyId - company identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- type - type of business entity;\r\n- properties - object which can contain different set of data depending from jurisdiction and registry. Will be empty for this operation.\r\n\r\ncaseAddress - case address object:\r\n- caseAddressId - case address identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- rawAddress - address received from registry;\r\n- address - normalized address;\r\n\r\nAvailable case common status identifiers:\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n

statusId

\r\n
\r\n

Meaning

\r\n
\r\n

Applies to what Cases

\r\n
\r\n

Description

\r\n
\r\n

0

\r\n
\r\n

Initializing

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

\"Initializing Case\" (immediately after case created)

\r\n
\r\n

1

\r\n
\r\n

Data Collection

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

Data Collection is being performed for the case (either manually or automated) the case is considerred on hold until, an automatic or manual intervention gets done

\r\n
\r\n

2

\r\n
\r\n

Data Verification

\r\n
\r\n

\r\n

Companies and Individuals

\r\n

\r\n
\r\n

The Case is being verified for Data accuracy, integrity & quality

\r\n
\r\n

3

\r\n
\r\n

Ready

\r\n
\r\n

Companies and Individuals

\r\n\r\n
\r\n

\"Ready\" (When our automatic processes are finished and all sub-cases are also ready and the user can now work on the case)

\r\n
\r\n

4-49

\r\n
\r\n

Reserved

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

-

\r\n
\r\n

50

\r\n
\r\n

RetrievingBasicData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving basic company data\" (when we get status, registered address etc.)

\r\n
\r\n

51

\r\n
\r\n

IdentifyingControllingEntities

\r\n
\r\n

Companies

\r\n
\r\n

\"Identifying controlling entities\" (when we scan for director information)

\r\n
\r\n

52

\r\n
\r\n

RetrievingExtendedData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving extended company data, if available

\r\n
\r\n

53

\r\n
\r\n

DownloadingCompanyDocuments

\r\n
\r\n

Companies

\r\n
\r\n

\"Downloading company documents\" (while documents are being downloaded and classified)

\r\n
\r\n

54

\r\n
\r\n

IdentifyingBeneficialOwners

\r\n
\r\n

Companies

\r\n
\r\n

Identifying beneficial owners\" (by using OCR, Data Extraction or Machine Learning Techniques)

\r\n
\r\n

55

\r\n
\r\n

PreparingChildren

\r\n
\r\n

Companies

\r\n
\r\n

Preparing sub-case\" (when this case is ready but some parent company shareholder or corporate secretary/director was found and we are waiting for that sub-case to finish)

\r\n
\r\n

56

\r\n
\r\n

CheckingListedEntities

\r\n
\r\n

Companies

\r\n
\r\n

Checking for market listed entities

\r\n
\r\n

57-99

\r\n
\r\n

Reserved

\r\n
\r\n

Companies

\r\n
\r\n\r\n

 

\r\n
\r\n

100

\r\n
\r\n

PerformingAmlChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual AML Checks

\r\n
\r\n

101

\r\n
\r\n

PerformingAddressChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Address Checks in available Jurisdictions

\r\n
\r\n

102

\r\n
\r\n

PerformingCourtChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Courts Data Checks in available Jurisdictions

\r\n
\r\n

103-150

\r\n
\r\n

Reserved

\r\n
\r\n

Individuals

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
", "schema": { "$ref": "#/definitions/CaseDetailImportResult" }, "examples": { "application/json": { "details": { "common": { "caseCommonId": 10001, "caseCustomerId": 889, "customerId": 224, "customerName": "YourCustomer", "type": 1, "typeString": "Company", "scoring": 0, "complete": 0, "edit": true, "status": "Open", "statusChangedDatetime": null, "statusChangedBy": null, "statusId": 0, "caseDecision": null, "isVisible": true, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorUserName": "example@example.com", "createdDatetime": "2017-10-20T21:30:53.863", "updatedBySystem": null, "isAMLCase": false, "updatedByUser": null, "customerDepartmentId": 1249, "customerDepartmentName": "Management", "countryRisk": 4.77, "assignedUserId": null, "assignedUserName": null, "link": "https://app.knowyourcustomer.com/casecompany/10001/detail" }, "company": { "id": 3777, "caseCompanyId": 3777, "caseCommonId": 10001, "countryCodeISO31662": "GB", "entityName": "TEST AIR SERVICES LTD", "type": null, "description": "Case Generated from API2", "userId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "createdDatetime": "2017-10-20T21:30:54.09", "properties": {} }, "caseAddress": { "caseAddressId": 9950, "caseCommonId": 10001, "addressLine1": null, "addressLine2": null, "city": null, "stateProvince": null, "postcode": null, "country": null, "countryCodeISO31662": null, "countryId": null, "rawAddress": null, "address": null, "userId": null, "creatorName": null, "createdDatetime": "2017-10-20T21:30:54.093" } } } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Internal Error", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/individuals/{caseCommonId}/documents": { "get": { "description": "Gets individual documents", "operationId": "5a7c2edf1257bc18dcd6b71b", "summary": "Individual Documents", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "Case Common identifier", "required": true, "type": "number" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Return array of individual documents.", "schema": { "$ref": "#/definitions/IndividualDocumentsResult" }, "examples": { "application/json": "[\r\n {\r\n \"caseDocumentId\": 227841,\r\n \"category\": \"selfie\",\r\n \"name\": \"Selfie\",\r\n \"link\": \"https://kyc.azure-api.net/v2/documents/227841\"\r\n },\r\n {\r\n \"caseDocumentId\": 227840,\r\n \"category\": \"photoid\",\r\n \"name\": \"Photo ID\",\r\n \"link\": \"https://kyc.azure-api.net/v2/documents/227840\"\r\n },\r\n {\r\n \"caseDocumentId\": 227842,\r\n \"category\": \"poa\",\r\n \"name\": \"Address\",\r\n \"link\": \"https://kyc.azure-api.net/v2/documents/227842\"\r\n }\r\n]" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/{caseCommonId}/link/{childCaseCommonId}": { "post": { "description": "Links child case to parent company case", "operationId": "5a7c75371257bc18dcd6b71c", "summary": "Link Case To Company", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "Case Common identifier", "required": true, "type": "number" }, { "name": "childCaseCommonId", "in": "path", "description": "Child Case Common identifier", "required": true, "type": "number" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "linkCaseToCompanyBody", "in": "body", "schema": { "$ref": "#/definitions/LinkCaseToCompanyBody" }, "description": "Object describes what type of relation should be created between child case and parent company:\r\n\r\nrelationType - relation type. Possible values described in the table below;\r\n\r\nrelationRole - relation role. In case if relationType is Officer you can provide officer's position. If relationType is Shareholder usually Shareholder string used. If selected any other relationType, relationRole will be ignored;\r\n\r\nshares - In case if relationType is Shareholder you can provide amount of shares.\r\n\r\n\r\nPossible relationType values:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n \r\n
Relationship TypeDescription
SpouseSpouse
SpouseEquivalentPartner considered by national law as equivalent to spouse
CohabitantUnmarried partner or cohabitant
ChildChild
StepchildStepchild
DaughterInLawDaughter-in-law
SonInLawSon-in-law
SiblingSibling
StepsiblingStepsibling
HalfSiblingHalf sibling
ParentParent
StepparentStepparent
ParentInLawParent-in-law
GrandParentGrandparent
GrandchildGrandchild
BrotherInLawBrother-in-law
SisterInLawSister-in-law
BusinessAssociateBusiness associate
JointOwnerJoint owner
FellowShareholderOrPartnerFellow shareholder or partner
FinancialAdvisorFinancial Advisor
AttorneyAttorney
LawyerLawyer
AgentAgent
RepresentativeRepresentative
NomineeNominee
PrivatePoliticalAdvisorPrivate political advisor
PayorDirectRelativePayor Direct Relative
PayorOtherPayor Other
ShareholderShareholder
OfficerOfficer
PowerOfAttorneyPower of Attorney
" } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Company members structure.\r\n
\r\nAll returned member groups (controllingEntitiesAndIndividuals and shareholdersAndBeneficialOwners) can include cases for individuals and companies.\r\nEach returned member group got title which is represented by controllingEntitiesAndIndividualsTitle and shareholdersAndBeneficialOwnersTitle properties. These properties describe what kind of members the current group contains (\"Controlling Entities and Individuals\", \"Partners and Beneficial Owners\", etc).\r\n
\r\n\r\nEach member result object contains:\r\n- properties - object which can contain different set of data depending from jurisdiction and registry. Each registry provides different set of data.\r\n
Minimum dataset for company member: Company Name, Company Type,\r\n Company Registration Number, Company Status, Creation / Incorporation Date.\r\n
Minimum dataset for individual member: Individual Name, Individual Relation (Director | Secretary | Auditor | etc).\r\n\r\n- isKYCed - indicates if the particular member can be processed and verified;\r\n- memberType - type of the member. Can be \"Company\" or \"Individual\".", "schema": { "$ref": "#/definitions/CaseMembersResult" }, "examples": { "application/json": { "controllingEntitiesAndIndividualsTitle": "Controlling Entities and Individuals", "controllingEntitiesAndIndividuals": [ { "role": "Partner", "member": { "firstName": "Dan", "lastName": "Linddal Bechmann ANDERSEN", "caseCommonId": 14150, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "38 C Søndre Alle", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Alle 38 C , Rønne, 3700 Rønne, Denmark", "address": "38 C Søndre Alle, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Partner", "member": { "entityName": "AKTK ApS", "caseCommonId": 14151, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "12 Store Torvegade", "addressLine2": "", "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Store Torvegade 12, 3700 Rønne", "address": "12 Store Torvegade, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": { "Company Type": "Private company limited by shares", "Company Status": "Active", "Creation Date": "27/08/2012", "Registration Number": "34692394", "Other Names": "ALLINGE REVISION ApS; ALLINGE REVISIONSKONTOR ApS; CENTRUM REVISION ApS" } }, "memberType": "Company", "isKYCed": true }, { "role": "Partner", "member": { "firstName": "Ivan", "lastName": "Søren QVIST", "caseCommonId": 14152, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "2 A Elses Løkkevej", "addressLine2": null, "city": "Nexø", "stateProvince": null, "postcode": "3730", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark", "address": "2 A Elses Løkkevej, Nexø, 3730, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Partner", "member": { "firstName": "Ole", "lastName": "BONDERUP", "caseCommonId": 14153, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "1 Broløkke", "addressLine2": null, "city": "Svaneke", "stateProvince": null, "postcode": "3740", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Broløkke 1 , Østermarie, 3740 Svaneke, Denmark", "address": "1 Broløkke, Svaneke, 3740, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Partner", "member": { "firstName": "Anders", "lastName": "KOFOED", "caseCommonId": 14154, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "94 Aaker", "addressLine2": null, "city": "Aakirkeby", "stateProvince": null, "postcode": "3720", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark", "address": "94 Aaker, Aakirkeby, 3720, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Partner", "member": { "firstName": "Tonny", "lastName": "KOFOED", "caseCommonId": 14155, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "37 Kapelvej", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Kapelvej 37 , Rønne, 3700 Rønne, Denmark", "address": "37 Kapelvej, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Director", "member": { "firstName": "Dan", "lastName": "Linddal Bechmann ANDERSEN", "caseCommonId": 14150, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "38 C Søndre Alle", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Alle 38 C , Rønne, 3700 Rønne, Denmark", "address": "38 C Søndre Alle, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "role": "Director", "member": { "entityName": "AKTK ApS", "caseCommonId": 14151, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "12 Store Torvegade", "addressLine2": "", "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Store Torvegade 12, 3700 Rønne", "address": "12 Store Torvegade, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": { "Company Type": "Private company limited by shares", "Company Status": "Active", "Creation Date": "27/08/2012", "Registration Number": "34692394", "Other Names": "ALLINGE REVISION ApS; ALLINGE REVISIONSKONTOR ApS; CENTRUM REVISION ApS" } }, "memberType": "Company", "isKYCed": true }, { "role": "Director", "member": { "firstName": "Ivan", "lastName": "Søren QVIST", "caseCommonId": 14152, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "2 A Elses Løkkevej", "addressLine2": null, "city": "Nexø", "stateProvince": null, "postcode": "3730", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark", "address": "2 A Elses Løkkevej, Nexø, 3730, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false }, { "role": "Director", "member": { "firstName": "Ole", "lastName": "BONDERUP", "caseCommonId": 14153, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "1 Broløkke", "addressLine2": null, "city": "Svaneke", "stateProvince": null, "postcode": "3740", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Broløkke 1 , Østermarie, 3740 Svaneke, Denmark", "address": "1 Broløkke, Svaneke, 3740, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false }, { "role": "Director", "member": { "firstName": "Anders", "lastName": "KOFOED", "caseCommonId": 14154, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "94 Aaker", "addressLine2": null, "city": "Aakirkeby", "stateProvince": null, "postcode": "3720", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark", "address": "94 Aaker, Aakirkeby, 3720, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false }, { "role": "Director", "member": { "firstName": "Tonny", "lastName": "KOFOED", "caseCommonId": 14155, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "37 Kapelvej", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Kapelvej 37 , Rønne, 3700 Rønne, Denmark", "address": "37 Kapelvej, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false } ], "shareholdersAndBeneficialOwnersTitle": "Partners and Beneficial Owners", "shareholdersAndBeneficialOwners": [ { "shares": 27, "member": { "firstName": "Anders", "lastName": "KOFOED", "caseCommonId": 14154, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "94 Aaker", "addressLine2": null, "city": "Aakirkeby", "stateProvince": null, "postcode": "3720", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark", "address": "94 Aaker, Aakirkeby, 3720, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "shares": 27, "member": { "firstName": "Tonny", "lastName": "KOFOED", "caseCommonId": 14155, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "37 Kapelvej", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Kapelvej 37 , Rønne, 3700 Rønne, Denmark", "address": "37 Kapelvej, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": true }, { "shares": 0, "member": { "firstName": "Dan", "lastName": "Linddal Bechmann ANDERSEN", "caseCommonId": 14150, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "38 C Søndre Alle", "addressLine2": null, "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Søndre Alle 38 C , Rønne, 3700 Rønne, Denmark", "address": "38 C Søndre Alle, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false }, { "shares": 0, "member": { "entityName": "AKTK ApS", "caseCommonId": 14151, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "12 Store Torvegade", "addressLine2": "", "city": "Rønne", "stateProvince": null, "postcode": "3700", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Store Torvegade 12, 3700 Rønne", "address": "12 Store Torvegade, Rønne, 3700, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": { "Company Type": "Private company limited by shares", "Company Status": "Active", "Creation Date": "27/08/2012", "Registration Number": "34692394", "Other Names": "ALLINGE REVISION ApS; ALLINGE REVISIONSKONTOR ApS; CENTRUM REVISION ApS" } }, "memberType": "Company", "isKYCed": false }, { "shares": 0, "member": { "firstName": "Ivan", "lastName": "Søren QVIST", "caseCommonId": 14152, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "2 A Elses Løkkevej", "addressLine2": null, "city": "Nexø", "stateProvince": null, "postcode": "3730", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark", "address": "2 A Elses Løkkevej, Nexø, 3730, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false }, { "shares": 0, "member": { "firstName": "Ole", "lastName": "BONDERUP", "caseCommonId": 14153, "jurisdictionId": 62, "codeISO31662": "DK", "address": { "caseAddressId": null, "caseCommonId": null, "addressLine1": "1 Broløkke", "addressLine2": null, "city": "Svaneke", "stateProvince": null, "postcode": "3740", "country": "Denmark", "countryCodeISO31662": null, "countryId": 62, "rawAddress": "Broløkke 1 , Østermarie, 3740 Svaneke, Denmark", "address": "1 Broløkke, Svaneke, 3740, Denmark", "userId": null, "creatorName": null, "createdDatetime": null }, "properties": {} }, "memberType": "Individual", "isKYCed": false } ] } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/{caseCommonId}/properties/{dataType}": { "delete": { "description": "Removes company case property by data type.", "operationId": "5a4222311257bc0ca8459629", "summary": "Remove Company Case Property", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "dataType", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Return all case properties for particular company case.", "schema": { "$ref": "#/definitions/CasePropertiesArrayResult" }, "examples": { "application/json": "[\r\n {\r\n \"dataType\": \"Activity Type\",\r\n \"data\": \"Any type\"\r\n },\r\n {\r\n \"dataType\": \"Other Names\",\r\n \"data\": \"Test Limited\"\r\n }\r\n]" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid DataType", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/individuals/{caseCommonId}/properties/{dataType}": { "delete": { "description": "Removes individual case property by data type.", "operationId": "5a422a1a1257bc0ca845962a", "summary": "Remove Individual Case Property", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "dataType", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Return all case properties for particular individual case.", "schema": { "$ref": "#/definitions/CasePropertiesArrayResult" }, "examples": { "application/json": "[\r\n {\r\n \"dataType\": \"Birth Date\",\r\n \"data\": \"01/01/2000\"\r\n }\r\n]" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid DataType", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/{caseCommonId}/documents/request": { "post": { "description": "Creates request for documents on the given company case, return link to portal to upload requested documents and indicates if sms/email were sent.", "operationId": "5a4cf8051257bc0f544bda51", "summary": "Request Company Case Documents", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "documentsRequestBodyCompany", "in": "body", "schema": { "$ref": "#/definitions/DocumentsRequestBodyCompany" }, "description": "Body should contain array of documents you want to request. Also you can provide optional email and phone number to receive access code to upload requested documents using external portal or mobile application.\r\n- documents - array of documents you want to reqeust. If you are going to request mandatory documenst, you can get categories of these documents for particular case by calling /companies/caseCommonId/documents/mandatory endpoint;\r\n- email - optional email address to receive email with access code and link to upload portal;\r\n- phone - optional phone number to reveive SMS with access code to upload reqeusted documents using mobile application.\r\n- allowEdit - optional paramether that allow edit/add company information." } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Response contains the following data:\r\n- uploadUrl - link to portal to upload requested documents;\r\n- accessCode - access code which should be provided during uploading documents using both upload portal and mobile application;\r\n- emailSent - indicates if email was sent;\r\n- smsSent - indicates if SMS was sent.", "schema": { "$ref": "#/definitions/DocumentsRequestResult" }, "examples": { "application/json": { "uploadUrl": "https://dev.kycl.io/upload/+A00000", "accessCode": "+A00000", "emailSent": true, "smsSent": false } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/individuals/{caseCommonId}/documents/request": { "post": { "description": "Creates request for documents on the given individual case, return link to portal to upload requested documents and indicates if sms/email were sent.", "operationId": "5a4d00951257bc0f544bda52", "summary": "Request Individual Case Documents", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "documentsRequestBodyIndividual", "in": "body", "schema": { "$ref": "#/definitions/DocumentsRequestBodyIndividual" }, "description": "Body should contain array of documents you want to request. Also you can provide optional email and phone number to receive access code to upload requested documents using external portal or mobile application.\r\n- documents - array of documents you want to reqeust. If you are going to upload mandatory document, you can get categories of these documents for particular case by calling /individuals/caseCommonId/documents/mandatory endpoint;\r\n- email - optional email address to receive email with access code and link to upload portal;\r\n- phone - optional phone number to reveive SMS with access code to upload reqeusted documents using mobile application.\r\n- allowEdit - optional paramether that allow to edit/add individual information." } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Response contains the following data:\r\n- uploadUrl - link to portal to upload requested documents;\r\n- accessCode - access code which should be provided during uploading documents using both upload portal and mobile application;\r\n- emailSent - indicates if email was sent;\r\n- smsSent - indicates if SMS was sent.", "schema": { "$ref": "#/definitions/DocumentsRequestResult" }, "examples": { "application/json": { "uploadUrl": "https://dev.kycl.io/upload/+A00000", "accessCode": "+A00000", "emailSent": false, "smsSent": false } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/{caseCommonId}/documents/upload": { "post": { "description": "Uploads the document to company case.", "operationId": "5a58882f1257bc0aa819a425", "summary": "Upload Document To Company Case", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "schema": {}, "description": "Request body includes file you wanted to upload and form-data to describe uploaded document.\r\n\r\nDocument data:
\r\nfileCat - category of the file you want to upload. If you are going to upload mandatory document, you can get categories of the mandatory documents for particular case by calling /companies/caseCommonId/documents/mandatory endpoint;\r\n\r\nname - document name. If you are uploading mandatory document and this document will be found by provided fileCat for particulatr case then the doucument will be saved with standard name defined in the system. Mandatory field;\r\n\r\ncreateNewStep - the flag indicating if new step should be created in the Additional KYC Steps. Please, note, if you create document and category of this document known by the system, then this document will be created in the step defined by system. Otherwise, if current flag is empty or false, then new document will be created in the Other Company Documents step. If flag is true - new step will be created in the Additional KYC Steps section." } ], "consumes": [ "multipart/form-data" ], "responses": { "200": { "description": "Uploaded document result", "schema": { "$ref": "#/definitions/UploadDocumentResult" }, "examples": { "application/json": { "caseCommonId": 16627, "caseDocumentId": 93349, "category": "REPOF", "name": "Register Report <1/12/2018>", "link": "https://kyc.azure-api.net/v2/documents/93349" } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid API Key", "timeStamp": "7/28/2017 2:15:51 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/individuals/{caseCommonId}/documents/upload": { "post": { "description": "Uploads the document to Individual case.", "operationId": "5a589e401257bc0aa819a426", "summary": "Upload Document To Individual Case", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "schema": {}, "description": "Request body includes file you wanted to upload and form-data to describe uploaded document.\r\n\r\nDocument data:
\r\nfileCat - category of the file you want to upload. If you are going to upload mandatory document, you can get categories of the mandatory documents for particular case by calling /individuals/caseCommonId/documents/mandatory endpoint. Default categories are the following: photoid, poa, selfie;\r\n\r\nname - document name. If you are uploading mandatory document and this document will be found by provided fileCat for particulatr case then the doucument will be saved with standard name defined in the system. Mandatory field;\r\n\r\ncreateNewStep - the flag indicating if new step should be created for uploaded document. Please, note, if you create document and category of this document known by the system, then this document will be created in the step defined by system. Otherwise, if current flag is empty or false, then new document will be created in the Proof Of Identity step. If flag is true - new step will be created in the Identity section." } ], "consumes": [ "multipart/form-data" ], "responses": { "200": { "description": "Uploaded document result", "schema": { "$ref": "#/definitions/UploadDocumentResult" }, "examples": { "application/json": { "caseCommonId": 16627, "caseDocumentId": 93349, "category": "photoid", "name": "Photo ID", "link": "https://kyc.azure-api.net/v2/documents/93349" } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid API Key", "timeStamp": "7/28/2017 2:15:51 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/individuals/import": { "post": { "description": "Import a new individual case", "operationId": "5af35097049b5e1e7cb9059c", "summary": "Import Individual Case", "parameters": [ { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "createIndividualCaseBody", "in": "body", "schema": { "$ref": "#/definitions/CreateIndividualCaseBody" }, "description": "Individual data.\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n \r\n
NameDescriptionMandatory
firstNameThe First NameNo
lastNameThe Family NameNo
nationalityCodeiso31662Nationality Country ISO 3166-2 codeNo
birthDateThe Date of Birth (Format: dd/mm/yyyy)No
addressLine1Address Line 1No
addressLine2Address Line 2No
postcodeThe postcodeNo
cityThe cityNo
provinceThe state/provinceNo
countryCodeiso31662Address Country ISO 3166-2 codeNo
propertiesArray of the individual properties, has same request body structure as described at the POST /individuals/caseCommonId/properties endpointNo
journeyNameName of the journeyNo
" } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Return created individual case details:\r\n\r\ncommon - case common object:\r\n- caseCommonId - individual case identifier in Know Your Customer web application;\r\n- caseCustomerId - identifier of the individual case for related customer;\r\n- type - case common type code.\r\n- typeString - case common type name. Text representation of the type;\r\n- complete - indicates percentage of case automatic verification process completion;\r\n- edit - deprecated field;\r\n- status - current status of the individual case, representing the case has been manually \r\nclosed by a user or not. Can be \"Open\" or \"Closed\";\r\n- statusId - representing current state of the case. Available status identifiers see in the table below.\r\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\r\n- isVisible - indicates if the individual case is visible in Know Your Customer web \r\n- isAMLCase - indicates should we check on anti money laundering only or not;\r\n- countryRisk - anti money laundering country risk score;\r\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\r\n\r\nindividual - case individual object:\r\n- caseIndividualId - individual identifier in Know Your Customer web application;\r\n- firstName - individual's first name;\r\n- lastName - individual's last name;\r\n- countryCodeISO31662 - country code of individual case defined in ISO 3166-2 standard;\r\n- nationalityCodeISO31662 - country code of the nationality defined in ISO 3166-2 standard;\r\n- properties - object which can contain different set of data like Date of Birth, Occupdation, etc;\r\n\r\ncaseAddress - case address object:\r\n- caseAddressId - case address identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- rawAddress - address received from registry;\r\n- address - normalized address;\r\n\r\nAvailable case common status identifiers:\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n

statusId

\r\n
\r\n

Meaning

\r\n
\r\n

Applies to what Cases

\r\n
\r\n

Description

\r\n
\r\n

0

\r\n
\r\n

Initializing

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

\"Initializing Case\" (immediately after case created)

\r\n
\r\n

1

\r\n
\r\n

Data Collection

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

Data Collection is being performed for the case (either manually or automated) the case is considerred on hold until, an automatic or manual intervention gets done

\r\n
\r\n

2

\r\n
\r\n

Data Verification

\r\n
\r\n

\r\n

Companies and Individuals

\r\n

\r\n
\r\n

The Case is being verified for Data accuracy, integrity & quality

\r\n
\r\n

3

\r\n
\r\n

Ready

\r\n
\r\n

Companies and Individuals

\r\n\r\n
\r\n

\"Ready\" (When our automatic processes are finished and all sub-cases are also ready and the user can now work on the case)

\r\n
\r\n

4-49

\r\n
\r\n

Reserved

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

-

\r\n
\r\n

50

\r\n
\r\n

RetrievingBasicData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving basic company data\" (when we get status, registered address etc.)

\r\n
\r\n

51

\r\n
\r\n

IdentifyingControllingEntities

\r\n
\r\n

Companies

\r\n
\r\n

\"Identifying controlling entities\" (when we scan for director information)

\r\n
\r\n

52

\r\n
\r\n

RetrievingExtendedData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving extended company data, if available

\r\n
\r\n

53

\r\n
\r\n

DownloadingCompanyDocuments

\r\n
\r\n

Companies

\r\n
\r\n

\"Downloading company documents\" (while documents are being downloaded and classified)

\r\n
\r\n

54

\r\n
\r\n

IdentifyingBeneficialOwners

\r\n
\r\n

Companies

\r\n
\r\n

Identifying beneficial owners\" (by using OCR, Data Extraction or Machine Learning Techniques)

\r\n
\r\n

55

\r\n
\r\n

PreparingChildren

\r\n
\r\n

Companies

\r\n
\r\n

Preparing sub-case\" (when this case is ready but some parent company shareholder or corporate secretary/director was found and we are waiting for that sub-case to finish)

\r\n
\r\n

56

\r\n
\r\n

CheckingListedEntities

\r\n
\r\n

Companies

\r\n
\r\n

Checking for market listed entities

\r\n
\r\n

57-99

\r\n
\r\n

Reserved

\r\n
\r\n

Companies

\r\n
\r\n\r\n

 

\r\n
\r\n

100

\r\n
\r\n

PerformingAmlChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual AML Checks

\r\n
\r\n

101

\r\n
\r\n

PerformingAddressChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Address Checks in available Jurisdictions

\r\n
\r\n

102

\r\n
\r\n

PerformingCourtChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Courts Data Checks in available Jurisdictions

\r\n
\r\n

103-150

\r\n
\r\n

Reserved

\r\n
\r\n

Individuals

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
", "schema": { "$ref": "#/definitions/IndividualCaseDetailResult" }, "examples": { "application/json": { "caseDetail": { "details": { "individual": { "caseIndividualId": 8905, "firstName": "John", "lastName": "Doe", "countryCodeISO31662": "PT", "country": "Portugal", "email": null, "phone": null, "nationalityCountryCodeISO31662": "GB", "nationalityCountry": "United kingdom", "caseCommonId": 14050, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "properties": { "Birth Date": "01/01/1990" }, "createdDatetime": "2017-11-24T11:44:17.22" }, "common": { "caseCommonId": 14069, "caseCustomerId": 1165, "customerId": 224, "customerName": "AndreiCo", "type": 2, "typeString": "Individual", "scoring": 0, "complete": 0, "edit": true, "status": "Open", "statusChangedDatetime": null, "statusChangedBy": null, "statusId": null, "caseDecision": null, "isVisible": true, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorUserName": "avgybarev@gmail.com", "createdDatetime": "2017-11-24T13:41:58.03", "updatedBySystem": null, "isAMLCase": null, "updatedByUser": null, "customerDepartmentId": 1249, "customerDepartmentName": "Management", "countryRisk": 4.77, "assignedUserId": null, "assignedUserName": null, "link": "https://dev.knowyourcustomer.com/caseindividual/14069/detail" }, "caseAddress": { "caseAddressId": 7792, "caseCommonId": 7839, "addressLine1": "40-44 Wyndham Place Wyndham Street Central", "addressLine2": "", "city": "Hong Kong", "stateProvince": null, "postcode": null, "country": "Hong kong", "countryCodeISO31662": "HK", "countryId": 3, "rawAddress": "6/F., WYNDHAM PLACE,40-44 WYNDHAM STREET, CENTRAL, HONG KONG, HONG KONG", "address": "40-44 Wyndham Place Wyndham Street Central, Hong Kong, Hong kong", "userId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorName": "example@example.com", "createdDatetime": "2017-09-26T05:22:52.893" } } } } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Internal Error", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/individuals/{caseCommonId}/link/{childCaseCommonId}": { "post": { "description": "Links individual child case to parent individual case.", "operationId": "5abde14d049b5e19fce1a103", "summary": "Link Individual Case To Individual", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "Case Common identifier", "required": true, "type": "number" }, { "name": "childCaseCommonId", "in": "path", "description": "Child Case Common identifier", "required": true, "type": "number" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "linkCaseToIndividualBody", "in": "body", "schema": { "$ref": "#/definitions/LinkCaseToIndividualBody" }, "description": "Object describes what type of relation should be created between child case and parent individual:\r\n\r\nrelationType - relation type. Possible values described in the table below.\r\n\r\nPossible relationType values:\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n \r\n
Relationship TypeDescription
SpouseSpouse
SpouseEquivalentPartner considered by national law as equivalent to spouse
CohabitantUnmarried partner or cohabitant
ChildChild
StepchildStepchild
DaughterInLawDaughter-in-law
SonInLawSon-in-law
SiblingSibling
StepsiblingStepsibling
HalfSiblingHalf sibling
ParentParent
StepparentStepparent
ParentInLawParent-in-law
GrandParentGrandparent
GrandchildGrandchild
BrotherInLawBrother-in-law
SisterInLawSister-in-law
BusinessAssociateBusiness associate
JointOwnerJoint owner
FellowShareholderOrPartnerFellow shareholder or partner
FinancialAdvisorFinancial Advisor
AttorneyAttorney
LawyerLawyer
AgentAgent
RepresentativeRepresentative
NomineeNominee
PrivatePoliticalAdvisorPrivate political advisor
PayorDirectRelativePayor Direct Relative
PayorOtherPayor Other
PowerOfAttorneyPower of Attorney
" } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Return new created relationship description.", "schema": { "$ref": "#/definitions/LinkCaseToIndividualResult" }, "examples": { "application/json": { "success": true, "relationshipDescriptions": [ "Sibling" ] } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/{caseCommonId}/identity": { "put": { "description": "Update existing company identity information.", "operationId": "5af2ed13049b5e10c0c830b8", "summary": "Update Company", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "", "required": true, "type": "number" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "createCaseBody", "in": "body", "schema": { "$ref": "#/definitions/CreateCaseBody" }, "description": "Company data.\r\n\r\n \r\n\t\t\r\n\t\t\t\r\n \r\n \r\n\t\t\r\n\t\r\n\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\r\n
NameDescriptionMandatory
codeiso31662Country ISO 3166-2 codeNo
entityNameCompany NameNo
externalCodeCompany registration numberNo
addressLine1Address Line 1No
addressLine2Address Line 2No
postcodePostcodeNo
cityCityNo
provinceProvinceNo
countryCodeiso31662Address Country ISO 3166-2 codeNo
" } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Return created company case details:\r\n\r\ncommon - case common object:\r\n- caseCommonId - newly created company case identifier in Know Your Customer web application;\r\n- caseCustomerId - identifier of the company case for related customer;\r\n- type - case common type code.\r\n- typeString - case common type name. Text representation of the type. Can be \"Company\" or \"Individual\";\r\n- complete - indicates percentage of case automatic verification process completion;\r\n-edit - deprecated field;\r\n- status - current status of the company case, representing the case has been manually \r\nclosed by a user or not. Can be \"Open\" or \"Closed\";\r\n- statusId - represents current state of the case. Available status identifiers see in the table below.\r\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\r\n- isVisible - indicates if the company case is visible in Know Your Customer web \r\n- isAMLCase - indicates should we check on anti money laundering only or not;\r\n- countryRisk - anti money laundering country risk score;\r\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\r\n\r\ncompany - case company object:\r\n- caseCompanyId - company identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- type - type of business entity;\r\n- properties - object which can contain different set of data depending from jurisdiction and registry. Will be empty for this operation.\r\n\r\ncaseAddress - case address object:\r\n- caseAddressId - case address identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- rawAddress - address received from registry;\r\n- address - normalized address;\r\n\r\nAvailable case common status identifiers:\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n

statusId

\r\n
\r\n

Meaning

\r\n
\r\n

Applies to what Cases

\r\n
\r\n

Description

\r\n
\r\n

0

\r\n
\r\n

Initializing

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

\"Initializing Case\" (immediately after case created)

\r\n
\r\n

1

\r\n
\r\n

Data Collection

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

Data Collection is being performed for the case (either manually or automated) the case is considerred on hold until, an automatic or manual intervention gets done

\r\n
\r\n

2

\r\n
\r\n

Data Verification

\r\n
\r\n

\r\n

Companies and Individuals

\r\n

\r\n
\r\n

The Case is being verified for Data accuracy, integrity & quality

\r\n
\r\n

3

\r\n
\r\n

Ready

\r\n
\r\n

Companies and Individuals

\r\n\r\n
\r\n

\"Ready\" (When our automatic processes are finished and all sub-cases are also ready and the user can now work on the case)

\r\n
\r\n

4-49

\r\n
\r\n

Reserved

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

-

\r\n
\r\n

50

\r\n
\r\n

RetrievingBasicData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving basic company data\" (when we get status, registered address etc.)

\r\n
\r\n

51

\r\n
\r\n

IdentifyingControllingEntities

\r\n
\r\n

Companies

\r\n
\r\n

\"Identifying controlling entities\" (when we scan for director information)

\r\n
\r\n

52

\r\n
\r\n

RetrievingExtendedData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving extended company data, if available

\r\n
\r\n

53

\r\n
\r\n

DownloadingCompanyDocuments

\r\n
\r\n

Companies

\r\n
\r\n

\"Downloading company documents\" (while documents are being downloaded and classified)

\r\n
\r\n

54

\r\n
\r\n

IdentifyingBeneficialOwners

\r\n
\r\n

Companies

\r\n
\r\n

Identifying beneficial owners\" (by using OCR, Data Extraction or Machine Learning Techniques)

\r\n
\r\n

55

\r\n
\r\n

PreparingChildren

\r\n
\r\n

Companies

\r\n
\r\n

Preparing sub-case\" (when this case is ready but some parent company shareholder or corporate secretary/director was found and we are waiting for that sub-case to finish)

\r\n
\r\n

56

\r\n
\r\n

CheckingListedEntities

\r\n
\r\n

Companies

\r\n
\r\n

Checking for market listed entities

\r\n
\r\n

57-99

\r\n
\r\n

Reserved

\r\n
\r\n

Companies

\r\n
\r\n\r\n

 

\r\n
\r\n

100

\r\n
\r\n

PerformingAmlChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual AML Checks

\r\n
\r\n

101

\r\n
\r\n

PerformingAddressChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Address Checks in available Jurisdictions

\r\n
\r\n

102

\r\n
\r\n

PerformingCourtChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Courts Data Checks in available Jurisdictions

\r\n
\r\n

103-150

\r\n
\r\n

Reserved

\r\n
\r\n

Individuals

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
", "schema": { "$ref": "#/definitions/CaseDetailResult" }, "examples": { "application/json": { "caseDetail": { "details": { "common": { "caseCommonId": 10001, "caseCustomerId": 889, "customerId": 224, "customerName": "YourCustomer", "type": 1, "typeString": "Company", "scoring": 0, "complete": 0, "edit": true, "status": "Open", "statusChangedDatetime": null, "statusChangedBy": null, "statusId": 0, "caseDecision": null, "isVisible": true, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorUserName": "example@example.com", "createdDatetime": "2017-10-20T21:30:53.863", "updatedBySystem": null, "isAMLCase": false, "updatedByUser": null, "customerDepartmentId": 1249, "customerDepartmentName": "Management", "countryRisk": 4.77, "assignedUserId": null, "assignedUserName": null, "link": "https://app.knowyourcustomer.com/casecompany/10001/detail" }, "company": { "id": 3777, "caseCompanyId": 3777, "caseCommonId": 10001, "countryCodeISO31662": "GB", "entityName": "TEST AIR SERVICES LTD", "type": null, "description": "Case Generated from API2", "userId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "createdDatetime": "2017-10-20T21:30:54.09", "properties": {} }, "caseAddress": { "caseAddressId": 9950, "caseCommonId": 10001, "addressLine1": null, "addressLine2": null, "city": null, "stateProvince": null, "postcode": null, "country": null, "countryCodeISO31662": null, "countryId": null, "rawAddress": null, "address": null, "userId": null, "creatorName": null, "createdDatetime": "2017-10-20T21:30:54.093" } } } } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Internal Error", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/individuals/{caseCommonId}/identity": { "put": { "description": "Update an existing individual case", "operationId": "5af2efbb049b5e10c0c830b9", "summary": "Update Individual Case", "parameters": [ { "name": "caseCommonId", "in": "path", "required": true, "type": "number" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "createIndividualCaseBody", "in": "body", "schema": { "$ref": "#/definitions/CreateIndividualCaseBody" }, "description": "Individual data.\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n\t\t\r\n \r\n \r\n \r\n \r\n \r\n
NameDescriptionMandatory
firstNameThe First NameNo
lastNameThe Family NameNo
nationalityCodeiso31662Nationality Country ISO 3166-2 codeNo
birthDateThe Date of Birth (Format: dd/mm/yyyy)No
addressLine1Address Line 1No
addressLine2Address Line 2No
postcodeThe postcodeNo
cityThe cityNo
provinceThe state/provinceNo
countryCodeiso31662Address Country ISO 3166-2 codeNo
" } ], "consumes": [ "application/json" ], "responses": { "200": { "description": "Return created individual case details:\r\n\r\ncommon - case common object:\r\n- caseCommonId - individual case identifier in Know Your Customer web application;\r\n- caseCustomerId - identifier of the individual case for related customer;\r\n- type - case common type code.\r\n- typeString - case common type name. Text representation of the type;\r\n- complete - indicates percentage of case automatic verification process completion;\r\n- edit - deprecated field;\r\n- status - current status of the individual case, representing the case has been manually \r\nclosed by a user or not. Can be \"Open\" or \"Closed\";\r\n- statusId - representing current state of the case. Available status identifiers see in the table below.\r\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\r\n- isVisible - indicates if the individual case is visible in Know Your Customer web \r\n- isAMLCase - indicates should we check on anti money laundering only or not;\r\n- countryRisk - anti money laundering country risk score;\r\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\r\n\r\nindividual - case individual object:\r\n- caseIndividualId - individual identifier in Know Your Customer web application;\r\n- firstName - individual's first name;\r\n- lastName - individual's last name;\r\n- countryCodeISO31662 - country code of individual case defined in ISO 3166-2 standard;\r\n- nationalityCodeISO31662 - country code of the nationality defined in ISO 3166-2 standard;\r\n- properties - object which can contain different set of data like Date of Birth, Occupdation, etc;\r\n\r\ncaseAddress - case address object:\r\n- caseAddressId - case address identifier in Know Your Customer web application;\r\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\r\n- rawAddress - address received from registry;\r\n- address - normalized address;\r\n\r\nAvailable case common status identifiers:\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n\r\n
\r\n

statusId

\r\n
\r\n

Meaning

\r\n
\r\n

Applies to what Cases

\r\n
\r\n

Description

\r\n
\r\n

0

\r\n
\r\n

Initializing

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

\"Initializing Case\" (immediately after case created)

\r\n
\r\n

1

\r\n
\r\n

Data Collection

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

Data Collection is being performed for the case (either manually or automated) the case is considerred on hold until, an automatic or manual intervention gets done

\r\n
\r\n

2

\r\n
\r\n

Data Verification

\r\n
\r\n

\r\n

Companies and Individuals

\r\n

\r\n
\r\n

The Case is being verified for Data accuracy, integrity & quality

\r\n
\r\n

3

\r\n
\r\n

Ready

\r\n
\r\n

Companies and Individuals

\r\n\r\n
\r\n

\"Ready\" (When our automatic processes are finished and all sub-cases are also ready and the user can now work on the case)

\r\n
\r\n

4-49

\r\n
\r\n

Reserved

\r\n
\r\n

Companies and Individuals

\r\n
\r\n

-

\r\n
\r\n

50

\r\n
\r\n

RetrievingBasicData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving basic company data\" (when we get status, registered address etc.)

\r\n
\r\n

51

\r\n
\r\n

IdentifyingControllingEntities

\r\n
\r\n

Companies

\r\n
\r\n

\"Identifying controlling entities\" (when we scan for director information)

\r\n
\r\n

52

\r\n
\r\n

RetrievingExtendedData

\r\n
\r\n

Companies

\r\n
\r\n

Retrieving extended company data, if available

\r\n
\r\n

53

\r\n
\r\n

DownloadingCompanyDocuments

\r\n
\r\n

Companies

\r\n
\r\n

\"Downloading company documents\" (while documents are being downloaded and classified)

\r\n
\r\n

54

\r\n
\r\n

IdentifyingBeneficialOwners

\r\n
\r\n

Companies

\r\n
\r\n

Identifying beneficial owners\" (by using OCR, Data Extraction or Machine Learning Techniques)

\r\n
\r\n

55

\r\n
\r\n

PreparingChildren

\r\n
\r\n

Companies

\r\n
\r\n

Preparing sub-case\" (when this case is ready but some parent company shareholder or corporate secretary/director was found and we are waiting for that sub-case to finish)

\r\n
\r\n

56

\r\n
\r\n

CheckingListedEntities

\r\n
\r\n

Companies

\r\n
\r\n

Checking for market listed entities

\r\n
\r\n

57-99

\r\n
\r\n

Reserved

\r\n
\r\n

Companies

\r\n
\r\n\r\n

 

\r\n
\r\n

100

\r\n
\r\n

PerformingAmlChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual AML Checks

\r\n
\r\n

101

\r\n
\r\n

PerformingAddressChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Address Checks in available Jurisdictions

\r\n
\r\n

102

\r\n
\r\n

PerformingCourtChecks

\r\n
\r\n

Individuals

\r\n
\r\n

Performing Individual Courts Data Checks in available Jurisdictions

\r\n
\r\n

103-150

\r\n
\r\n

Reserved

\r\n
\r\n

Individuals

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
\r\n\r\n

 

\r\n
", "schema": { "$ref": "#/definitions/IndividualCaseDetailResult" }, "examples": { "application/json": { "caseDetail": { "details": { "individual": { "caseIndividualId": 8905, "firstName": "John", "lastName": "Doe", "countryCodeISO31662": "PT", "country": "Portugal", "email": null, "phone": null, "nationalityCountryCodeISO31662": "GB", "nationalityCountry": "United kingdom", "caseCommonId": 14050, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "properties": { "Birth Date": "01/01/1990" }, "createdDatetime": "2017-11-24T11:44:17.22" }, "common": { "caseCommonId": 14069, "caseCustomerId": 1165, "customerId": 224, "customerName": "AndreiCo", "type": 2, "typeString": "Individual", "scoring": 0, "complete": 0, "edit": true, "status": "Open", "statusChangedDatetime": null, "statusChangedBy": null, "statusId": null, "caseDecision": null, "isVisible": true, "creatorId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorUserName": "avgybarev@gmail.com", "createdDatetime": "2017-11-24T13:41:58.03", "updatedBySystem": null, "isAMLCase": null, "updatedByUser": null, "customerDepartmentId": 1249, "customerDepartmentName": "Management", "countryRisk": 4.77, "assignedUserId": null, "assignedUserName": null, "link": "https://dev.knowyourcustomer.com/caseindividual/14069/detail" }, "caseAddress": { "caseAddressId": 7792, "caseCommonId": 7839, "addressLine1": "40-44 Wyndham Place Wyndham Street Central", "addressLine2": "", "city": "Hong Kong", "stateProvince": null, "postcode": null, "country": "Hong kong", "countryCodeISO31662": "HK", "countryId": 3, "rawAddress": "6/F., WYNDHAM PLACE,40-44 WYNDHAM STREET, CENTRAL, HONG KONG, HONG KONG", "address": "40-44 Wyndham Place Wyndham Street Central, Hong Kong, Hong kong", "userId": "db557fed-99b5-4c8a-b3c9-5d2d42d2bc13", "creatorName": "example@example.com", "createdDatetime": "2017-09-26T05:22:52.893" } } } } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Internal Error", "timeStamp": "7/28/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companytypes": { "get": { "description": "Get available jurisdictions", "operationId": "5b84e90ff664c597254ec0cd", "summary": "Company Types", "parameters": [ { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns list of the available jurisdictions", "schema": { "$ref": "#/definitions/" }, "examples": { "application/json": "[\r\n \"Branch\",\r\n \"Company limited by guarantee\",\r\n \"Consortium\",\r\n \"Cooperative\",\r\n \"Corporation\",\r\n \"External company\",\r\n \"Foreign branch\",\r\n \"Foreign Companie\",\r\n \"Foreign subsidiary company\",\r\n \"Foundation\",\r\n \"General partnership\",\r\n \"Government owned with variable capital and variable shareholders\",\r\n \"Incorporated\",\r\n \"Investment company\",\r\n \"Limited Liability Company\",\r\n \"Limited liability cooperative\",\r\n \"Limited liability foundation\",\r\n \"Limited Liability Limited Partnership\",\r\n \"Limited Liability Partnerships\",\r\n \"Limited Partnership\",\r\n \"Limited partnership - ILP\",\r\n \"Limited partnership - LLP\",\r\n \"Limited partnership - LP\",\r\n \"Madras\",\r\n \"Management Corporation\",\r\n \"Mosque\",\r\n \"National Association\",\r\n \"National Trust and Savings Association\",\r\n \"News Bureau\",\r\n \"Other/Non-corporate\",\r\n \"Other/Partnership\",\r\n \"Private company\",\r\n \"Private company limited by guarantee without share capital\",\r\n \"Private company limited by shares\",\r\n \"Private foundation\",\r\n \"Professional Limited Liability Company\",\r\n \"Property management company\",\r\n \"Public Accounting Firm\",\r\n \"Public company\",\r\n \"Public Company Limited by Guarantee\",\r\n \"Public company limited by shares\",\r\n \"Register of Commerce and Companies\",\r\n \"Sole proprietorship\",\r\n \"State-owned enterprise\",\r\n \"Trade Union\",\r\n \"Trust\",\r\n \"Undetermined\",\r\n \"Unlimited company\"\r\n]" } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid API Key", "timeStamp": "7/28/2017 2:15:51 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/companies/{caseCommonId}/amlchecks": { "get": { "description": "Gets the AML Check results for the selected company", "operationId": "5bed8b6c24ff61cef6216e33", "summary": "Company AML Checks", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "Case Common identifier", "required": true, "type": "number" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns all AML Check entries found in the case and not excluded\r\n\r\ncompany - case common details:\r\n- caseCommonId - company case identifier in Know Your Customer web application;\r\n- lastName - the name of the company;\r\n\r\nworldChecks - all AML entries found in WorldCheck. Each entity has the following properties:\r\n- category - the type of company (e.g. CORPORATE, BANK, etc.);\r\n- firstName - always empty;\r\n- lastName - the name of the company found in Worldcheck;\r\n- dateOfBirth - always empty;\r\n- placeOfBirth - always empty;\r\n- citizenship - country in which the company operates;\r\n- aliases - other possible names for the company;\r\n- entered - date in which the entry was added in WorldCheck;\r\n- externalMediaFound - links to additional information about the entry;\r\n- furtherInformation - additional information about the entry;\r\n- locations - additional details about the location in which the entry was added;\r\n\r\nlexisNexisChecks - all AML entries found in LexisNexis. Each entity has the following properties:\r\n- category - the type of AML entry (e.g. PEP, ADVERSEMEDIA, etc.);\r\n- firstName - always empty;\r\n- lastName - the name of the company found in Worldcheck;\r\n- dateOfBirth - always empty;\r\n- placeOfBirth - always empty;\r\n- occupation - always empty;\r\n- entered - date in which the entry was added in WorldCheck;\r\n- associations - additional information about the entry;\r\n", "schema": { "$ref": "#/definitions/CompanyAmlCheckResult" }, "examples": { "application/json": { "company": { "caseCommonId": 100921, "lastName": "TESTING COMPANY" }, "worldChecks": [ { "category": "CORPORATE", "firstName": "", "lastName": "TESTING COMPANY", "dateOfBirth": "", "placeOfBirth": "", "citizenship": "INDONESIA", "aliases": "ALIAS COMPANY", "entered": "2002/02/08", "externalMediaFound": "https://en.wikipedia.org/wiki/Lorem_ipsum https://en.wikipedia.org/wiki/Lorem_ipsum", "furtherInformation": "[BIOGRAPHY] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc sapien quam, tempor nec ipsum a. (PEP) (1966- ). [IDENTIFICATION] To be determined. [REPORTS] To be determined.", "locations": "~ Lake Providence, Louisiana ~ USA" } ], "lexisNexisChecks": [ { "category": "PEP", "firstName": "", "lastName": "TESTING COMPANY", "dateOfBirth": null, "placeOfBirth": null, "occupation": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc sapien quam, tempor nec ipsum a.", "entered": "2016/08/04", "associations": "Wife (PEP:Govt Branch Member): Testing, Name, 1328143,Relative (PEP:Govt Branch Member): Name, Test Other, 124531" } ] } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } }, "/individuals/{caseCommonId}/amlchecks": { "get": { "description": "Gets AML Check results for the selected case", "operationId": "5bed8a736951ef71f349d631", "summary": "Individual AML Checks", "parameters": [ { "name": "caseCommonId", "in": "path", "description": "Case Common identifier", "required": true, "type": "number" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns all AML Check entries found in the case and not excluded\r\n\r\nindividual - case common details:\r\n- caseCommonId - company case identifier in Know Your Customer web application;\r\n- lastName - the last name of the person;\r\n- firstName - the first name of the person;\r\n\r\nworldChecks - all AML entries found in WorldCheck. Each entity has the following properties:\r\n- category - the type of AML entry (e.g. INDIVIDUAL, TERRORISM, LEGAL, etc.);\r\n- firstName - the first name of the person;\r\n- lastName - the last name of the person;\r\n- dateOfBirth - the date in which person was born;\r\n- placeOfBirth - the location in which person was born;\r\n- citizenship - the citizenship of hte person;\r\n- aliases - other names found for the person;\r\n- entered - date in which the entry was added in WorldCheck;\r\n- externalMediaFound - links to additional information about the entry;\r\n- furtherInformation - additional information about the entry;\r\n- locations - additional details about the location in which the entry was added;\r\n\r\nlexisNexisChecks - all AML entries found in LexisNexis. Each entity has the following properties:\r\n- category - the type of AML entry (e.g. INDIVIDUAL, TERRORISM, LEGAL, etc.);\r\n- firstName the first name of the person;\r\n- lastName - the last name of the person;\r\n- dateOfBirth - the date in which person was born;\r\n- placeOfBirth - the location in which person was born;\r\n- occupation - the occupation of the person;\r\n- entered - date in which the entry was added in WorldCheck;\r\n- associations - additional information about the entry;\r\n", "schema": { "$ref": "#/definitions/IndividualAmlCheckResult" }, "examples": { "application/json": { "individual": { "caseCommonId": 14456, "lastName": "Testing", "firstName": "Individual" }, "worldChecks": [ { "category": "LEGAL", "firstName": "Testing I", "lastName": "Indivdual", "dateOfBirth": "", "placeOfBirth": "", "citizenship": "USA", "aliases": "", "entered": "2010/08/24", "externalMediaFound": "https://en.wikipedia.org/wiki/Lorem_ipsum https://en.wikipedia.org/wiki/Lorem_ipsum", "furtherInformation": "[BIOGRAPHY] Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc sapien quam, tempor nec ipsum a. (reported 2009). [IDENTIFICATION] To be determined. [REPORTS] To be determined.", "locations": "~ Lake Providence, Louisiana ~ USA" } ], "lexisNexisChecks": [] } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } } }, "definitions": { "WorldCheckDetail": { "type": "object", "properties": { "category": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dateOfBirth": { "type": "string" }, "placeOfBirth": { "type": "string" }, "citizenship": { "type": "string" }, "aliases": { "type": "string" }, "entered": { "type": "string" }, "externalMediaFound": { "type": "string" }, "furtherInformation": { "type": "string" }, "locations": { "type": "string" } } }, "LexisNexisChecksDetail": { "type": "object", "properties": { "category": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dateOfBirth": { "type": "string" }, "placeOfBirth": { "type": "string" }, "occupation": { "type": "string" }, "entered": { "type": "string" }, "associations": { "type": "string" } } }, "IndividualAmlCheckDetail": { "type": "object", "properties": { "caseCommonId": { "type": "number" }, "firstName": { "type": "string" }, "lastName": { "type": "string" } } }, "CompanyAmlCheckDetail": { "type": "object", "properties": { "caseCommonId": { "type": "number" }, "lastName": { "type": "string" } } }, "IndividualAmlCheckResult": { "type": "object", "properties": { "individual": { "$ref": "#/definitions/IndividualAmlCheckDetail" }, "worldChecks": { "type": "array", "items": { "$ref": "#/definitions/WorldCheckDetail" } }, "lexisNexisChecks": { "type": "array", "items": { "$ref": "#/definitions/LexisNexisChecksDetail" } } } }, "CompanyAmlCheckResult": { "type": "object", "properties": { "company": { "$ref": "#/definitions/CompanyAmlCheckDetail" }, "worldChecks": { "type": "array", "items": { "$ref": "#/definitions/WorldCheckDetail" } }, "lexisNexisChecks": { "type": "array", "items": { "$ref": "#/definitions/LexisNexisChecksDetail" } } } }, "JurisdictionsResult": { "type": "object", "properties": { "jurisdictions": { "type": "object", "properties": { "jurisdiction": { "type": "array", "items": { "$ref": "#/definitions/Jurisdiction" } } } } } }, "Jurisdiction": { "type": "object", "properties": { "name": { "type": "string" }, "codeiso31662": { "type": "string" }, "area": { "type": "string" }, "isautomated": { "type": "boolean" } } }, "UploadDocumentResult": { "type": "object", "properties": { "caseCommonId": { "type": "number" }, "caseDocumentId": { "type": "number" }, "category": { "type": "string" }, "name": { "type": "string" }, "link": { "type": "string" } } }, "VerificationIndividualIdentityResult": { "type": "object", "properties": { "comparisonReport": { "type": "object", "properties": { "firstNameConfirmation": { "type": "object", "properties": { "value": { "type": "string" }, "recognizedValue": { "type": "string" }, "status": { "type": "string", "enum": [ "NotRecognized", "Missing", "Confirmed", "Deviates" ] } } }, "lastNameConfirmation": { "type": "object", "properties": { "value": { "type": "string" }, "recognizedValue": { "type": "string" }, "status": { "type": "string", "enum": [ "NotRecognized", "Missing", "Confirmed", "Deviates" ] } } }, "birthDateConfirmation": { "type": "object", "properties": { "badDateValueReason": { "type": "string" }, "value": { "type": "string" }, "recognizedValue": { "type": "string" }, "status": { "type": "string", "enum": [ "NotRecognized", "Missing", "Confirmed", "Deviates" ] } } } } }, "success": { "type": "boolean", "description": "True if document is verified" }, "message": { "type": "string", "description": "Information message" }, "triggeredRule": { "type": "object", "properties": { "scenario": { "type": "string", "description": "Unique rule id (for debug purposes)" }, "result": { "type": "string", "description": "Result type", "enum": [ "Valid", "Warning", "Fail" ] }, "message": { "type": "string", "description": "UI message key that explains the result", "enum": [ "DocumentPassedAuthentication", "AtLeastOneAuthenticationCheckFailed", "AtLeastOneForgeryIdentified", "DataElementsMistmach", "CouldNotPerformAuthenticationChecks", "CouldNotRecognizeDocument", "CouldNotRecognizeOrAuthenticateDocument", "DocumentIsExpired", "NotIdentityDocument", "DocumentIsBlackListed", "SomeElementsPreventedFullAuthenticationChecks", "DocumentRejected", "AtLeastOneAuthenticationCheckWasIndecisive", "NoAuthenticationChecksWerePerformed", "LowQualityDocument", "SomeAuthenticationChecksWereNotPerformed", "PagesDontMatch" ] }, "sensitivity": { "type": "string", "description": "Rule sensitivity level", "enum": [ "Low", "Medium", "High" ] }, "properties": { "type": "object", "properties": { "failUpload": { "type": "boolean", "description": "Is failure related to bad image quality and retaking the photo may improve the result" } } } } }, "imageQuality": { "type": "object", "properties": { "percentage": { "type": "integer", "description": "Image quality percentage" }, "value": { "type": "string", "description": "Image quality level", "enum": [ "Undefined", "VeryLow", "Low", "Average", "High", "Perfect" ] } } }, "forgeryTests": { "type": "array", "items": { "type": "object", "properties": { "group": { "type": "string", "description": "Forgery test group" }, "type": { "type": "string", "description": "Forgery test type" }, "result": { "type": "string", "description": "Forgery test result", "enum": [ "Authenticated", "Forged", "Unconclusive", "UnableToComplete", "NotRelevant" ] } } } }, "identityReport": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "birthDate": { "type": "string" }, "sourceDocument": { "type": "string" }, "birthPlace": { "type": "string" }, "expiryDate": { "type": "string" }, "documentNumber": { "type": "string" }, "address": { "type": "string" } } } } }, "VerificationIdentityResult": { "type": "object", "properties": { "success": { "type": "boolean", "description": "True if document is verified" }, "message": { "type": "string", "description": "Information message" }, "triggeredRule": { "type": "object", "properties": { "scenario": { "type": "string", "description": "Unique rule id (for debug purposes)" }, "result": { "type": "string", "description": "Result type", "enum": [ "Valid", "Warning", "Fail" ] }, "message": { "type": "string", "description": "UI message key that explains the result", "enum": [ "DocumentPassedAuthentication", "AtLeastOneAuthenticationCheckFailed", "AtLeastOneForgeryIdentified", "DataElementsMistmach", "CouldNotPerformAuthenticationChecks", "CouldNotRecognizeDocument", "CouldNotRecognizeOrAuthenticateDocument", "DocumentIsExpired", "NotIdentityDocument", "DocumentIsBlackListed", "SomeElementsPreventedFullAuthenticationChecks", "DocumentRejected", "AtLeastOneAuthenticationCheckWasIndecisive", "NoAuthenticationChecksWerePerformed", "LowQualityDocument", "SomeAuthenticationChecksWereNotPerformed", "PagesDontMatch" ] }, "sensitivity": { "type": "string", "description": "Rule sensitivity level", "enum": [ "Low", "Medium", "High" ] }, "properties": { "type": "object", "properties": { "failUpload": { "type": "boolean", "description": "Is failure related to bad image quality and retaking the photo may improve the result" } } } } }, "imageQuality": { "type": "object", "properties": { "percentage": { "type": "integer", "description": "Image quality percentage" }, "value": { "type": "string", "description": "Image quality level", "enum": [ "Undefined", "VeryLow", "Low", "Average", "High", "Perfect" ] } } }, "forgeryTests": { "type": "array", "items": { "type": "object", "properties": { "group": { "type": "string", "description": "Forgery test group" }, "type": { "type": "string", "description": "Forgery test type" }, "result": { "type": "string", "description": "Forgery test result", "enum": [ "Authenticated", "Forged", "Unconclusive", "UnableToComplete", "NotRelevant" ] } } } }, "identityReport": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "birthDate": { "type": "string" }, "sourceDocument": { "type": "string" }, "birthPlace": { "type": "string" }, "expiryDate": { "type": "string" }, "documentNumber": { "type": "string" }, "address": { "type": "string" } } } } }, "ChinaVerificationResult": { "type": "object", "properties": { "verified": { "type": "boolean" }, "message": { "type": "string" } } }, "CaseCommon": { "type": "object", "properties": { "caseCommonId": { "type": "integer" }, "caseCustomerId": { "type": "integer" }, "customerId": { "type": "integer" }, "customerName": { "type": "string" }, "type": { "type": "integer" }, "typeString": { "type": "string", "enum": [ "Company", "Individual" ] }, "scoring": { "type": "integer" }, "complete": { "type": "integer" }, "edit": { "type": "boolean", "description": "Don't use this property. It's deprecated and will be deleted since next version." }, "status": { "type": "string", "enum": [ "Open", "Closed" ] }, "statusChangedDatetime": { "type": "string" }, "statusChangedBy": { "type": "string" }, "statusId": { "type": "integer" }, "isVisible": { "type": "boolean" }, "creatorId": { "type": "string" }, "creatorUserName": { "type": "string" }, "createdDatetime": { "type": "string" }, "updatedBySystem": { "type": "string" }, "isAMLCase": { "type": "boolean" }, "updatedByUser": { "type": "string" }, "customerDepartmentId": { "type": "integer" }, "customerDepartmentName": { "type": "string" }, "countryRisk": { "type": "number" }, "assignedUserId": { "type": "string" }, "assignedUserName": { "type": "string" }, "link": { "type": "string" } } }, "CaseCompany": { "type": "object", "properties": { "id": { "type": "integer" }, "caseCompanyId": { "type": "integer" }, "caseCommonId": { "type": "integer" }, "countryCodeISO31662": { "type": "string" }, "entityName": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "userId": { "type": "string" }, "creatorId": { "type": "string" }, "createdDatetime": { "type": "string" }, "properties": { "type": "object" } } }, "CaseIndividual": { "type": "object", "properties": { "caseIndividualId": { "type": "integer" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "caseCommonId": { "type": "integer" }, "countryCodeISO31662": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "nationalityCountryCodeISO31662": { "type": "string" }, "nationalityCountry": { "type": "string" }, "creatorId": { "type": "string" }, "createdDatetime": { "type": "string" }, "properties": { "type": "object" } } }, "CompaniesSearchResult": { "type": "object", "properties": { "companySearch": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "rawname": { "type": "string" }, "externalCode": { "type": "string" }, "rawAddress": { "type": "string" } } } } } } } }, "CaseDetailResult": { "type": "object", "properties": { "caseDetail": { "type": "object", "properties": { "details": { "type": "object", "properties": { "common": { "$ref": "#/definitions/CaseCommon" }, "isCaseAMLPositive": { "type": "boolean" }, "company": { "$ref": "#/definitions/CaseCompany" }, "caseAddress": { "$ref": "#/definitions/CaseAddress" } } } } } } }, "CaseDetailImportResult": { "type": "object", "properties": { "details": { "type": "object", "properties": { "common": { "$ref": "#/definitions/CaseCommon" }, "company": { "$ref": "#/definitions/CaseCompany" }, "caseAddress": { "$ref": "#/definitions/CaseAddress" } } } } }, "CompaniesList": { "type": "array", "items": { "type": "object", "properties": { "common": { "$ref": "#/definitions/CaseCommon" }, "isCaseAMLPositive": { "type": "boolean" }, "company": { "$ref": "#/definitions/CaseCompany" }, "caseAddress": { "$ref": "#/definitions/CaseAddress" } } } }, "IndividualsList": { "type": "array", "items": { "type": "object", "properties": { "common": { "$ref": "#/definitions/CaseCommon" }, "isCaseAMLPositive": { "type": "boolean" }, "company": { "$ref": "#/definitions/CaseIndividual" }, "caseAddress": { "$ref": "#/definitions/CaseAddress" } } } }, "IndividualCaseDetailResult": { "type": "object", "properties": { "caseDetail": { "type": "object", "properties": { "details": { "type": "object", "properties": { "common": { "$ref": "#/definitions/CaseCommon" }, "isCaseAMLPositive": { "type": "boolean" }, "individual": { "$ref": "#/definitions/CaseIndividual" }, "caseAddress": { "$ref": "#/definitions/CaseAddress" } } } } } } }, "DataTypesResult": { "type": "array", "items": { "type": "string" } }, "CasePropertiesArrayBodyCompanies": { "type": "array", "items": { "$ref": "#/definitions/CaseProperty" }, "example": "[{\r\n \"dataType\": \"Activity Type\",\r\n \"data\": \"Any type\"\r\n},\r\n{\r\n \"dataType\": \"Other Names\",\r\n \"data\": \"Test Limited\"\r\n}]" }, "CasePropertiesArrayResult": { "type": "array", "items": { "$ref": "#/definitions/CaseProperty" } }, "CasePropertiesArrayBodyIndividual": { "type": "array", "items": { "$ref": "#/definitions/CaseProperty" }, "example": "[{\r\n \"dataType\": \"Birth Date\",\r\n \"data\": \"01/01/1990\"\r\n}]" }, "LinkCaseToCompanyBody": { "type": "object", "properties": { "relationType": { "type": "string", "enum": [ "Officer", "Shareholder" ] }, "relationRole": { "type": "string" }, "shares": { "type": "integer" } }, "example": "{\r\n \"relationType\": \"Shareholder\",\r\n \"relationRole\": \"Shareholder\",\r\n \"shares\": 50000\r\n}" }, "LinkCaseToIndividualBody": { "type": "object", "properties": { "relationType": { "type": "string" } }, "example": "{\r\n \"relationType\": \"Agent\"\r\n}" }, "LinkCaseToIndividualResult": { "type": "object", "properties": { "success": { "type": "boolean" }, "relationshipDescriptions": { "type": "array", "items": { "type": "string" } } } }, "CaseProperty": { "type": "object", "properties": { "dataType": { "type": "string" }, "data": { "type": "string" } } }, "DocumentWithDocumentId": { "type": "object", "properties": { "caseDocumentId": { "type": "integer" }, "category": { "type": "string" }, "name": { "type": "string" }, "link": { "type": "string" } } }, "IndividualDocumentsResult": { "type": "array", "items": { "$ref": "#/definitions/DocumentWithDocumentId" } }, "CompanyDocumentsResult": { "type": "object", "properties": { "caseCommonId": { "type": "number" }, "name": { "type": "string" }, "documents": { "type": "object", "properties": { "groupName": { "description": "This property can have name such as Company Identity Documents, Other Company Documents, etc", "type": "array", "items": { "$ref": "#/definitions/Document" } } } }, "controllingEntitiesAndIndividuals": { "type": "array", "items": { "type": "object", "properties": { "caseCommonId": { "type": "string" }, "name": { "type": "string" }, "documents": { "type": "object", "properties": { "groupName": { "description": "This property can have name such as Company Identity Documents, Other Company Documents, etc", "type": "array", "items": { "$ref": "#/definitions/Document" } } } } } } }, "shareholdersAndBeneficialOwners": { "type": "array", "items": { "type": "object", "properties": { "caseCommonId": { "type": "string" }, "name": { "type": "string" }, "documents": { "type": "object", "properties": { "groupName": { "description": "This property can have name such as Company Identity Documents, Other Company Documents, etc", "type": "array", "items": { "$ref": "#/definitions/Document" } } } } } } } } }, "Document": { "type": "object", "properties": { "link": { "type": "string" }, "category": { "type": "string" }, "name": { "type": "string" } } }, "CaseMembersResult": { "type": "object", "properties": { "controllingEntitiesAndIndividualsTitle": { "type": "string" }, "controllingEntitiesAndIndividuals": { "type": "array", "items": { "allOf": [ { "$ref": "#/definitions/CompanyMember" }, { "$ref": "#/definitions/IndividualMember" } ] } }, "shareholdersAndBeneficialOwnersTitle": { "type": "string" }, "shareholdersAndBeneficialOwners": { "type": "array", "items": { "allOf": [ { "$ref": "#/definitions/CompanyMember" }, { "$ref": "#/definitions/IndividualMember" } ] } } } }, "CompanyMember": { "type": "object", "properties": { "shares": { "type": "integer" }, "isCaseAMLPositive": { "type": "boolean" }, "member": { "allOf": [ { "$ref": "#/definitions/Member" }, { "type": "object", "properties": { "entityName": { "type": "string" } } } ] }, "memberType": { "type": "string", "enum": [ "Individual", "Company" ] }, "isKYCed": { "type": "boolean" } } }, "IndividualMember": { "type": "object", "properties": { "role": { "type": "string" }, "isCaseAMLPositive": { "type": "boolean" }, "member": { "allOf": [ { "$ref": "#/definitions/Member" }, { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "residenceCountry": { "type": "string" } } } ] }, "memberType": { "type": "string", "enum": [ "Individual", "Company" ] }, "isKYCed": { "type": "boolean" } } }, "Member": { "type": "object", "properties": { "caseCommonId": { "type": "integer" }, "jurisdictionId": { "type": "integer" }, "codeISO31662": { "type": "string" }, "address": { "$ref": "#/definitions/CaseAddress" }, "properties": { "type": "object", "description": "Dynamic properties. Dataset depends from jurisdiction." } } }, "CaseAddress": { "type": "object", "properties": { "caseAddresId": { "type": "integer" }, "caseCommonId": { "type": "integer" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateProvince": { "type": "string" }, "postcode": { "type": "string" }, "country": { "type": "string" }, "countryCodeISO31662": { "type": "string" }, "countryId": { "type": "integer" }, "rawAddress": { "type": "string" }, "address": { "type": "string" }, "userId": { "type": "string" }, "creatorName": { "type": "string" }, "createdDatetime": { "type": "string" } } }, "DocumentsRequestResult": { "type": "object", "properties": { "uploadUrl": { "type": "string" }, "accessCode": { "type": "string" }, "emailSent": { "type": "boolean" }, "smsSent": { "type": "boolean" } } }, "DocumentsRequestBody": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "string" } }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "DocumentsRequestBodyCompany": { "type": "object", "$ref": "#/definitions/DocumentsRequestBody", "example": "{\r\n \"documents\": [\"NEWINC\", \"Annual Accounts\"],\r\n \"email\": \"example@example.com\",\r\n \"phone\": \"\",\r\n \"allowEdit\": true\r\n}" }, "DocumentsRequestBodyIndividual": { "type": "object", "$ref": "#/definitions/DocumentsRequestBody", "example": "{\r\n \"documents\": [\"photoid\"],\r\n \"email\": \"\",\r\n \"phone\": \"\",\r\n \"allowEdit\": true\r\n}" }, "DocumentCategories": { "type": "array", "items": { "type": "string" } }, "CaseSearchBody": { "type": "object", "properties": { "codeiso31662": { "type": "string" }, "query": { "type": "string" } }, "example": "{\r\n \"codeiso31662\" : \"GB\",\r\n \"query\": \"Test\"\r\n}" }, "ChinaBody": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "example": "{ \"id\" : \"513231200001010134\", \"name\" : \"潮安\" }" }, "CreateCaseBody": { "type": "object", "properties": { "rawname": { "type": "string" }, "externalCode": { "type": "string" }, "codeiso31662": { "type": "string" }, "entityType": { "type": "string" }, "companyType": { "type": "string" } }, "example": "{\r\n \"codeiso31662\": \"GB\",\r\n \"entityName\": \"UNITED ACCESS SERVICES LIMITED\",\r\n \"entityType\": \"Company\",\r\n \"companyType\": \"Private company limited by shares\",\r\n \"addressLine1\": \"Green st.\",\r\n \"addressLine2\": \"10\",\r\n \"postcode\": \"385493\",\r\n \"city\": \"Garlem\",\r\n \"countryCodeiso31662\": \"IE\"\r\n}" }, "ImportAddressModel": { "type": "object", "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "postcode": { "type": "string" }, "city": { "type": "string" }, "province": { "type": "string" }, "codeiso31662": { "type": "string" }, "type": { "type": "string" }, "rawAddress": { "type": "string" } } }, "ImportCompanyCaseBody": { "type": "object", "properties": { "entityName": { "type": "string" }, "codeiso31662": { "type": "string" }, "companyType": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/definitions/CaseProperty" } }, "address": { "type": "object", "$ref": "#/definitions/ImportAddressModel" } }, "example": "{\r\n \"entityName\": \"TEST AIR SERVICES LTD\",\r\n \"codeiso31662\": \"GB\",\r\n \"companyType\": \"Private company limited by shares\",\r\n \"address\": {\r\n \t\"codeiso31662\": \"GB\",\r\n \"rawAddress\": \"96 96 Pelhurst Road, Ryde, Isle Of Wight, England\"\r\n },\r\n \"properties\": [{\r\n \t\"dataType\": \"Company Status\",\r\n \t\"data\": \"Active\"\r\n },\r\n {\r\n \t\"dataType\": \"Registration Number\",\r\n \t\"data\": \"11111111\"\r\n }],\r\n \"journeyName\": \"All\"\r\n}" }, "CreateIndividualCaseBody": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "nationalityCodeiso31662": { "type": "string" }, "birthDate": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "postcode": { "type": "string" }, "city": { "type": "string" }, "province": { "type": "string" }, "countryCodeiso31662": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/definitions/CaseProperty" } } }, "example": "{\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"nationalityCodeiso31662\": \"GB\",\r\n \"birthDate\": \"01/01/1980\",\r\n \"addressLine1\": null,\r\n \"addressLine2\": null,\r\n \"postcode\": null,\r\n \"city\": null,\r\n \"province\": null,\r\n \"countryCodeiso31662\": null,\r\n \"properties\": [{\r\n \"dataType\": \"BirthDate\",\r\n \"data\": \"01/01/1990\"\r\n }],\r\n \"journeyName\": \"All\"\r\n}" }, "Body": {} }, "tags": [], "x-ms-paths": { "/verification/identity?caseCommonId={caseCommonId}": { "post": { "description": "Verifies uploaded passport document of the specified individual and performs First Name / Last Name / Birth Date comparison. (Result is not saved in the case)\r\n\r\nFinal verification result can be accessed from success or triggeredRule property. Properties are described in the response schema.", "operationId": "597b372afe9cef0db4739714", "summary": "Verify Individual Identity", "parameters": [ { "name": "caseCommonId", "in": "query", "description": "", "required": true, "type": "string" }, { "name": "ApiKey", "in": "header", "description": "", "required": true, "type": "string" }, { "name": "body", "in": "body", "schema": {}, "description": "Passport image. The request to verify passport should contain header Content-Type with multipart/form-data value." } ], "consumes": [ "multipart/form-data" ], "responses": { "200": { "description": "Verification result", "schema": { "$ref": "#/definitions/VerificationIndividualIdentityResult" }, "examples": { "application/json": { "comparisonReport": { "firstNameConfirmation": { "value": "Kevin Richard", "recognizedValue": "KEVIN RICHARD", "status": "Confirmed" }, "lastNameConfirmation": { "value": "Halligen", "recognizedValue": "HALLIGEN", "status": "Confirmed" }, "birthDateConfirmation": { "badDateValueReason": null, "value": "2017-10-08T00:00:00", "recognizedValue": "1961-07-14T00:00:00", "status": "Deviates" } }, "success": false, "message": null, "triggeredRule": { "scenario": "#4", "result": "Fail", "message": "DataElementsMistmach", "sensitivity": "Low", "decision": "Deviates", "properties": { "failUpload": false } }, "imageQuality": { "percentage": 71, "value": "High" }, "forgeryTests": [ { "group": "Data Integrity", "type": "Check Sum - Date of Birth", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Check Sum - Date of Expiry", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Check Sum - Document Number", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Check Sum - General", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Check Sum - Optional Data", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Data Comparison - Date of Birth", "result": "NotRelevant" }, { "group": "Data Integrity", "type": "Data Comparison - Expiry Date", "result": "NotRelevant" }, { "group": "Data Integrity", "type": "Data Comparison - Last Name", "result": "Unconclusive" }, { "group": "Data Integrity", "type": "Validation - MRZ Date of Birth", "result": "Authenticated" }, { "group": "Data Integrity", "type": "Validation - MRZ Date of Expiry", "result": "Authenticated" }, { "group": "Digital", "type": "Photo Replacement", "result": "Authenticated" }, { "group": "Digital", "type": "Text Replacement", "result": "NotRelevant" }, { "group": "Structure", "type": "Complete MRZ", "result": "Authenticated" }, { "group": "Structure", "type": "MRZ Fonts - Alphabetic", "result": "NotRelevant" }, { "group": "Structure", "type": "MRZ Fonts - Digits", "result": "Authenticated" } ], "identityReport": { "firstName": "KEVIN RICHARD", "lastName": "HALLIGEN", "birthDate": "1961-07-14T00:00:00", "sourceDocument": "Passport", "birthPlace": null, "expiryDate": "2012-02-13T00:00:00", "documentNumber": "S196082", "address": null } } } }, "400": { "description": "Invalid request parameters", "examples": { "application/json": { "statusCode": 400, "message": "Api Error", "apiErrors": [ { "description": "Invalid CaseCommonId", "timeStamp": "7/25/2017 12:26:21 PM" } ] } } }, "401": { "description": "Missing subscription key", "examples": { "application/json": { "statusCode": 401, "message": "Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API." } } }, "403": { "description": "Access denied", "examples": { "application/json": { "statusCode": 403, "message": "Access denied" } } } }, "produces": [ "application/json" ] } } } }