openapi: 3.0.1 info: title: KYC API v2 version: '1.0' servers: - url: https://api-demo.knowyourcustomer.com/v2 paths: '/companies/{caseCommonId}': get: summary: Company Details description: Gets company case details operationId: 597b372afe9cef0db473970c parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: "Returns company case details\n\ncommon - case common object:\n- caseCommonId - company case identifier in Know Your Customer web application;\n- caseCustomerId - identifier of the company case for related customer;\n- type - case common type code.\n- typeString - case common type name. Text representation of the type;\n- complete - indicates percentage of case automatic verification process completion;\n- edit - deprecated field;\n- status - current status of the company case, representing the case has been manually closed by a user or not. Can be \"Open\" or \"Closed\";\n- statusId - represents current state of the case. Available status identifiers see in the table below.\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\n- isVisible - indicates if the company case is visible in Know Your Customer web\n- isAMLCase - indicates should we check on anti money laundering only or not;\n- countryRisk - anti money laundering country risk score;\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\n- caseProcessingType - case processing type, \"\" for regular case processing, \"Lite\" for KYC Lite cases\n\nisCaseAMLPositive - True if the case contains at least one AML check not excluded. False otherwise\n\ncompany - case company object:\n- caseCompanyId - company identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- type - type of business entity;\n- properties - object which can contain different set of data depending from jurisdiction and registry. Each registry provides different set of data.\n\ncaseAddress - case address object:\n- caseAddressId - case address identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- rawAddress - address received from registry;\n- address - normalized address;\n\nAvailable case common status identifiers:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

statusId

\n
\n

Meaning

\n
\n

Applies to what Cases

\n
\n

Description

\n
\n

0

\n
\n

Initializing

\n
\n

Companies and Individuals

\n
\n

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

\n
\n

1

\n
\n

Data Collection

\n
\n

Companies and Individuals

\n
\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

\n
\n

2

\n
\n

Data Verification

\n
\n

\n

Companies and Individuals

\n

\n
\n

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

\n
\n

3

\n
\n

Ready

\n
\n

Companies and Individuals

\n\n
\n

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

\n
\n

4-49

\n
\n

Reserved

\n
\n

Companies and Individuals

\n
\n

-

\n
\n

50

\n
\n

RetrievingBasicData

\n
\n

Companies

\n
\n

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

\n
\n

51

\n
\n

IdentifyingControllingEntities

\n
\n

Companies

\n
\n

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

\n
\n

52

\n
\n

RetrievingExtendedData

\n
\n

Companies

\n
\n

Retrieving extended company data, if available

\n
\n

53

\n
\n

DownloadingCompanyDocuments

\n
\n

Companies

\n
\n

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

\n
\n

54

\n
\n

IdentifyingBeneficialOwners

\n
\n

Companies

\n
\n

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

\n
\n

55

\n
\n

PreparingChildren

\n
\n

Companies

\n
\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)

\n
\n

56

\n
\n

CheckingListedEntities

\n
\n

Companies

\n
\n

Checking for market listed entities

\n
\n

57-99

\n
\n

Reserved

\n
\n

Companies

\n
\n\n

 

\n
\n

100

\n
\n

PerformingAmlChecks

\n
\n

Individuals

\n
\n

Performing Individual AML Checks

\n
\n

101

\n
\n

PerformingAddressChecks

\n
\n

Individuals

\n
\n

Performing Individual Address Checks in available Jurisdictions

\n
\n

102

\n
\n

PerformingCourtChecks

\n
\n

Individuals

\n
\n

Performing Individual Courts Data Checks in available Jurisdictions

\n
\n

103-150

\n
\n

Reserved

\n
\n

Individuals

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n" content: application/json: example: caseDetail: details: common: caseCommonId: 7839 caseCustomerId: 677 customerId: 224 customerName: YourCustomer type: 1 typeString: Company scoring: 0 complete: 55 edit: true status: Open statusChangedDatetime: statusChangedBy: statusId: 3 caseDecision: Accepted isVisible: true creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 creatorUserName: example@example.com createdDatetime: '2017-09-26T05:22:52.8470000+00:00' updatedBySystem: '2017-09-26T05:26:11.4100000+00:00' isAMLCase: false updatedByUser: customerDepartmentId: 1249 customerDepartmentName: Management countryRisk: 5.51 assignedUserId: assignedUserName: link: https://app.knowyourcustomer.com/casecompany/7839/detail caseProcessingType: '' 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.8930000+00:00' 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: postcode: 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.8930000+00:00' '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied delete: summary: Remove Company Case description: 'Removes company case ' operationId: 5cdbabdb1a521c56f5a81585 parameters: - name: caseCommonId in: path description: Case common identifier required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Success message content: application/json: example: message: Case deleted successfully '400': description: Invalid request parameters / Access denied content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: 'Invalid request: Delete case: access denied.' timeStamp: '2019-05-15T07:35:39.0000000+00:00' '/companies/{caseCommonId}/documents': get: summary: Company Documents description: Gets company documents operationId: 597b372afe9cef0db4739710 parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: "Returns case documents structure.\ndocuments - object which contains grouped documents for requested case and sub-cases (child cases).\nEach sub-case can contain own documents object which includes documents related to this one sub-case. Sub-cases are grouped by sections." content: application/json: example: 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 content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/companies/{caseCommonId}/members': get: summary: Company Members description: "Gets company case members. Know Your Customer application supports two types of cases:\n- Company case - a case created for company that should be verified;\n- Individual case - a case created for individual for verification against AML worldcheck database, government photo id, etc.\n\nBoth types of cases can be members of the parent company case (can be officers and/or shareholders)." operationId: 59a71a2efe9cef13f4a647f4 parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: "Company members structure.\n
\nAll returned member groups (controllingEntitiesAndIndividuals, shareholdersAndBeneficialOwners and ultimateBeneficialOwners) can include cases for individuals and companies.\nEach returned member group got title which is represented by controllingEntitiesAndIndividualsTitle, shareholdersAndBeneficialOwnersTitle and ultimateBeneficialOwnersTitle properties. These properties describe what kind of members the current group contains (\"Controlling Entities and Individuals\", \"Partners and Beneficial Owners\", \"Ultimate Beneficial Owners\" etc).\n
\n\nEach member result object contains:\n- properties - object which can contain different set of data depending from jurisdiction and registry. Each registry provides different set of data.\n
Minimum dataset for company member: Company Name, Company Type,\n Company Registration Number, Company Status, Creation / Incorporation Date.\n
Minimum dataset for individual member: Individual Name, Individual Relation (Director | Secretary | Auditor | etc).\n\n- isCaseAMLPositive - True if the case contains at least one AML check not excluded. False otherwise;\n- isKYCed - indicates if the particular member can be processed and verified;\n- memberType - type of the member. Can be \"Company\" or \"Individual\".\n" content: application/json: example: 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: caseCommonId: addressLine1: 38 C Søndre Alle addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: 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: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Partner isCaseAMLPositive: false member: entityName: AKTK ApS caseCommonId: 14151 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 12 Store Torvegade addressLine2: '' city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Store Torvegade 12, 3700 Rønne' address: '12 Store Torvegade, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: 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: caseCommonId: addressLine1: 2 A Elses Løkkevej addressLine2: city: Nexø stateProvince: postcode: 3730 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark' address: '2 A Elses Løkkevej, Nexø, 3730, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Partner isCaseAMLPositive: false member: firstName: Ole lastName: BONDERUP caseCommonId: 14153 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 1 Broløkke addressLine2: city: Svaneke stateProvince: postcode: 3740 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Broløkke 1 , Østermarie, 3740 Svaneke, Denmark' address: '1 Broløkke, Svaneke, 3740, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Partner isCaseAMLPositive: false member: firstName: Anders lastName: KOFOED caseCommonId: 14154 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 94 Aaker addressLine2: city: Aakirkeby stateProvince: postcode: 3720 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark' address: '94 Aaker, Aakirkeby, 3720, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Partner isCaseAMLPositive: false member: firstName: Tonny lastName: KOFOED caseCommonId: 14155 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 37 Kapelvej addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Kapelvej 37 , Rønne, 3700 Rønne, Denmark' address: '37 Kapelvej, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Director isCaseAMLPositive: false member: firstName: Dan lastName: Linddal Bechmann ANDERSEN caseCommonId: 14150 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 38 C Søndre Alle addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: 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: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Director isCaseAMLPositive: false member: entityName: AKTK ApS caseCommonId: 14151 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 12 Store Torvegade addressLine2: '' city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Store Torvegade 12, 3700 Rønne' address: '12 Store Torvegade, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: 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: caseCommonId: addressLine1: 2 A Elses Løkkevej addressLine2: city: Nexø stateProvince: postcode: 3730 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark' address: '2 A Elses Løkkevej, Nexø, 3730, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false - role: Director isCaseAMLPositive: false member: firstName: Ole lastName: BONDERUP caseCommonId: 14153 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 1 Broløkke addressLine2: city: Svaneke stateProvince: postcode: 3740 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Broløkke 1 , Østermarie, 3740 Svaneke, Denmark' address: '1 Broløkke, Svaneke, 3740, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false - role: Director isCaseAMLPositive: false member: firstName: Anders lastName: KOFOED caseCommonId: 14154 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 94 Aaker addressLine2: city: Aakirkeby stateProvince: postcode: 3720 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark' address: '94 Aaker, Aakirkeby, 3720, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false - role: Director isCaseAMLPositive: false member: firstName: Tonny lastName: KOFOED caseCommonId: 14155 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 37 Kapelvej addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Kapelvej 37 , Rønne, 3700 Rønne, Denmark' address: '37 Kapelvej, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: 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: caseCommonId: addressLine1: 94 Aaker addressLine2: city: Aakirkeby stateProvince: postcode: 3720 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark' address: '94 Aaker, Aakirkeby, 3720, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - shares: 27 isCaseAMLPositive: false member: firstName: Tonny lastName: KOFOED caseCommonId: 14155 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 37 Kapelvej addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Kapelvej 37 , Rønne, 3700 Rønne, Denmark' address: '37 Kapelvej, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - shares: 0 isCaseAMLPositive: false member: firstName: Dan lastName: Linddal Bechmann ANDERSEN caseCommonId: 14150 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 38 C Søndre Alle addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: 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: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false - shares: 0 isCaseAMLPositive: false member: entityName: AKTK ApS caseCommonId: 14151 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 12 Store Torvegade addressLine2: '' city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Store Torvegade 12, 3700 Rønne' address: '12 Store Torvegade, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: 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: caseCommonId: addressLine1: 2 A Elses Løkkevej addressLine2: city: Nexø stateProvince: postcode: 3730 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark' address: '2 A Elses Løkkevej, Nexø, 3730, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false - shares: 0 isCaseAMLPositive: false member: firstName: Ole lastName: BONDERUP caseCommonId: 14153 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 1 Broløkke addressLine2: city: Svaneke stateProvince: postcode: 3740 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Broløkke 1 , Østermarie, 3740 Svaneke, Denmark' address: '1 Broløkke, Svaneke, 3740, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false ultimateBeneficialOwnersTitle: Ultimate Beneficial Owners (UBO) ultimateBeneficialOwners: - sharesPercentage: 27 isCaseAMLPositive: false member: firstName: Anders lastName: KOFOED caseCommonId: 14154 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 94 Aaker addressLine2: city: Aakirkeby stateProvince: postcode: 3720 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark' address: '94 Aaker, Aakirkeby, 3720, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - sharesPercentage: 27 isCaseAMLPositive: false member: firstName: Tonny lastName: KOFOED caseCommonId: 14155 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 37 Kapelvej addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Kapelvej 37 , Rønne, 3700 Rønne, Denmark' address: '37 Kapelvej, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied /companies: post: summary: Create Company Case description: Creates a new company case operationId: 597b372afe9cef0db473970f parameters: - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Company data.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameDescriptionMandatory
rawnameCompany nameYes
externalCodeCompany registration numberNo
codeiso31662Country ISO 3166-2 codeYes
entityType\n Company type. Allowance values: Company,\n Partnership and Trust. (Obsolete, this parameter will be removed in the future.)\n Yes (for not automated jurisdictions)
journeyNameName of the journeyNo
companyType\n Company type. Allowance values: get from /companytypes\n Yes (for not automated jurisdictions)
unregisteredEntity\n Can take value true or false. When true, registry is not queried for information about this entity\n No, false if not specified
caseProcessingType\n Case processing type. Allowance values: Empty string for regular processing, \"Lite\" for KYC lite case\n No (regular processing by default)
\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." content: application/json: example: rawname: UNITED ROPE ACCESS LIMITED externalCode: 11772285 codeiso31662: GB entityType: '' journeyName: All companyType: '' CaseProcessingType: '' responses: '200': description: "Return created company case details:\n\ncommon - case common object:\n- caseCommonId - newly created company case identifier in Know Your Customer web application;\n- caseCustomerId - identifier of the company case for related customer;\n- type - case common type code.\n- typeString - case common type name. Text representation of the type. Can be \"Company\" or \"Individual\";\n- complete - indicates percentage of case automatic verification process completion;\n-edit - deprecated field;\n- status - current status of the company case, representing the case has been manually \nclosed by a user or not. Can be \"Open\" or \"Closed\";\n- statusId - representing current state of the case. Available status identifiers see in the table below.\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\n- isVisible - indicates if the company case is visible in Know Your Customer web \n- isAMLCase - indicates should we check on anti money laundering only or not;\n- countryRisk - anti money laundering country risk score;\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\n\ncompany - case company object:\n- caseCompanyId - company identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- type - type of business entity;\n- properties - object which can contain different set of data depending from jurisdiction and registry. Will be empty for this operation.\n\ncaseAddress - case address object:\n- caseAddressId - case address identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- rawAddress - address received from registry;\n- address - normalized address;\n\nAvailable case common status identifiers:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

statusId

\n
\n

Meaning

\n
\n

Applies to what Cases

\n
\n

Description

\n
\n

0

\n
\n

Initializing

\n
\n

Companies and Individuals

\n
\n

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

\n
\n

1

\n
\n

Data Collection

\n
\n

Companies and Individuals

\n
\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

\n
\n

2

\n
\n

Data Verification

\n
\n

\n

Companies and Individuals

\n

\n
\n

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

\n
\n

3

\n
\n

Ready

\n
\n

Companies and Individuals

\n\n
\n

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

\n
\n

4-49

\n
\n

Reserved

\n
\n

Companies and Individuals

\n
\n

-

\n
\n

50

\n
\n

RetrievingBasicData

\n
\n

Companies

\n
\n

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

\n
\n

51

\n
\n

IdentifyingControllingEntities

\n
\n

Companies

\n
\n

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

\n
\n

52

\n
\n

RetrievingExtendedData

\n
\n

Companies

\n
\n

Retrieving extended company data, if available

\n
\n

53

\n
\n

DownloadingCompanyDocuments

\n
\n

Companies

\n
\n

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

\n
\n

54

\n
\n

IdentifyingBeneficialOwners

\n
\n

Companies

\n
\n

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

\n
\n

55

\n
\n

PreparingChildren

\n
\n

Companies

\n
\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)

\n
\n

56

\n
\n

CheckingListedEntities

\n
\n

Companies

\n
\n

Checking for market listed entities

\n
\n

57-99

\n
\n

Reserved

\n
\n

Companies

\n
\n\n

 

\n
\n

100

\n
\n

PerformingAmlChecks

\n
\n

Individuals

\n
\n

Performing Individual AML Checks

\n
\n

101

\n
\n

PerformingAddressChecks

\n
\n

Individuals

\n
\n

Performing Individual Address Checks in available Jurisdictions

\n
\n

102

\n
\n

PerformingCourtChecks

\n
\n

Individuals

\n
\n

Performing Individual Courts Data Checks in available Jurisdictions

\n
\n

103-150

\n
\n

Reserved

\n
\n

Individuals

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

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

statusId

\n
\n

Meaning

\n
\n

Applies to what Cases

\n
\n

Description

\n
\n

0

\n
\n

Initializing

\n
\n

Companies and Individuals

\n
\n

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

\n
\n

1

\n
\n

Data Collection

\n
\n

Companies and Individuals

\n
\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

\n
\n

2

\n
\n

Data Verification

\n
\n

\n

Companies and Individuals

\n

\n
\n

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

\n
\n

3

\n
\n

Ready

\n
\n

Companies and Individuals

\n\n
\n

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

\n
\n

4-49

\n
\n

Reserved

\n
\n

Companies and Individuals

\n
\n

-

\n
\n

50

\n
\n

RetrievingBasicData

\n
\n

Companies

\n
\n

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

\n
\n

51

\n
\n

IdentifyingControllingEntities

\n
\n

Companies

\n
\n

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

\n
\n

52

\n
\n

RetrievingExtendedData

\n
\n

Companies

\n
\n

Retrieving extended company data, if available

\n
\n

53

\n
\n

DownloadingCompanyDocuments

\n
\n

Companies

\n
\n

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

\n
\n

54

\n
\n

IdentifyingBeneficialOwners

\n
\n

Companies

\n
\n

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

\n
\n

55

\n
\n

PreparingChildren

\n
\n

Companies

\n
\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)

\n
\n

56

\n
\n

CheckingListedEntities

\n
\n

Companies

\n
\n

Checking for market listed entities

\n
\n

57-99

\n
\n

Reserved

\n
\n

Companies

\n
\n\n

 

\n
\n

100

\n
\n

PerformingAmlChecks

\n
\n

Individuals

\n
\n

Performing Individual AML Checks

\n
\n

101

\n
\n

PerformingAddressChecks

\n
\n

Individuals

\n
\n

Performing Individual Address Checks in available Jurisdictions

\n
\n

102

\n
\n

PerformingCourtChecks

\n
\n

Individuals

\n
\n

Performing Individual Courts Data Checks in available Jurisdictions

\n
\n

103-150

\n
\n

Reserved

\n
\n

Individuals

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n" content: application/json: example: - common: caseCommonId: 7839 caseCustomerId: 677 customerId: 224 customerName: YourCustomer type: 1 typeString: Company scoring: 0 complete: 55 edit: true status: Open statusChangedDatetime: statusChangedBy: statusId: 3 caseDecision: Accepted isVisible: true creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 creatorUserName: example@example.com createdDatetime: '2017-09-26T05:22:52.8470000+00:00' updatedBySystem: '2017-09-26T05:26:11.4100000+00:00' isAMLCase: false updatedByUser: customerDepartmentId: 1249 customerDepartmentName: Management countryRisk: 5.51 assignedUserId: assignedUserName: 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.8930000+00:00' 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: postcode: 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.8930000+00:00' '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/documents/{documentId}': get: summary: Download Document description: Download Document operationId: 597b372afe9cef0db4739711 parameters: - name: documentId in: path description: Document id required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Document data content: application/json: { } '401': description: Missing subscription key content: application/json: example: statusCode: 401 message: Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API. /jurisdictions: get: summary: Jurisdictions description: Get available jurisdictions operationId: 597b372afe9cef0db473970e parameters: - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Returns list of the available jurisdictions content: application/json: example: 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 content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid API Key timeStamp: '2017-07-28T14:15:51.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied /companies/search: post: summary: Search Companies description: "Executes companies search in the registry of the specified jurisdiciton based on:\n- country code defined in ISO 3166-2 standard;\n- search query (full or partial company name or company registration number).\n\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 parameters: - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Parameters definition:\n- codeiso31662 - jurisdiction's country code defined in ISO 3166-2 standard;\n- query - full or partial name or registration number of the company you are looking for." content: application/json: example: codeiso31662: GB query: Test responses: '200': description: "Returns companies list based on search criteria:\n- rawname - actual company name or trade name provided by registry site;\n- externalCode - company registration number provided by registry site;\n- rawAddress - company address provided by registry site;\n- companyStatus - company status provided by registry site." content: application/json: example: companySearch: results: - rawname: TEST AIR SERVICES LTD externalCode: 6650586 rawAddress: '96 96 Pelhurst Road, Ryde, Isle Of Wight, England' companyStatus: Active - rawname: TEST AIR SOLUTIONS LIMITED externalCode: 5661420 rawAddress: '225 Market Street, Hyde, Cheshire, SK14 1HF' companyStatus: Active '400': description: "Invalid request parameters. Errors descriptions:\n- Invalid Jurisdiction - provided jurisdiction is not automated yet. You cannot perform companies search for not automated jurisdictions." content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid Jurisdiction timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied /version: get: summary: Version description: Get current API version. operationId: 597b3729fe9cef0db473970b parameters: - name: ApiKey in: header required: true schema: type: string responses: '200': description: Success content: application/json: example: 2.0.1.23013 '401': description: Missing subscription key content: application/json: example: statusCode: 401 message: Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API. /individuals: post: summary: Create Individual Case description: Creates a new individual case operationId: 5a181acf1257bc13c421bd17 parameters: - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Individual data.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n \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
" content: application/json: example: firstName: John lastName: Doe nationalityCodeiso31662: GB birthDate: '1980-01-01T00:00:00.0000000+00:00' addressLine1: addressLine2: postcode: city: province: countryCodeiso31662: properties: - dataType: BirthDate data: '1990-01-01T00:00:00.0000000+00:00' journeyName: All responses: '200': description: "Return created individual case details:\n\ncommon - case common object:\n- caseCommonId - individual case identifier in Know Your Customer web application;\n- caseCustomerId - identifier of the individual case for related customer;\n- type - case common type code.\n- typeString - case common type name. Text representation of the type;\n- complete - indicates percentage of case automatic verification process completion;\n- edit - deprecated field;\n- status - current status of the individual case, representing the case has been manually \nclosed by a user or not. Can be \"Open\" or \"Closed\";\n- statusId - representing current state of the case. Available status identifiers see in the table below.\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\n- isVisible - indicates if the individual case is visible in Know Your Customer web \n- isAMLCase - indicates should we check on anti money laundering only or not;\n- countryRisk - anti money laundering country risk score;\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\n\nindividual - case individual object:\n- caseIndividualId - individual identifier in Know Your Customer web application;\n- firstName - individual's first name;\n- lastName - individual's last name;\n- countryCodeISO31662 - country code of individual case defined in ISO 3166-2 standard;\n- nationalityCodeISO31662 - country code of the nationality defined in ISO 3166-2 standard;\n- properties - object which can contain different set of data like Date of Birth, Occupdation, etc;\n\ncaseAddress - case address object:\n- caseAddressId - case address identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- rawAddress - address received from registry;\n- address - normalized address;\n\nAvailable case common status identifiers:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

statusId

\n
\n

Meaning

\n
\n

Applies to what Cases

\n
\n

Description

\n
\n

0

\n
\n

Initializing

\n
\n

Companies and Individuals

\n
\n

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

\n
\n

1

\n
\n

Data Collection

\n
\n

Companies and Individuals

\n
\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

\n
\n

2

\n
\n

Data Verification

\n
\n

\n

Companies and Individuals

\n

\n
\n

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

\n
\n

3

\n
\n

Ready

\n
\n

Companies and Individuals

\n\n
\n

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

\n
\n

4-49

\n
\n

Reserved

\n
\n

Companies and Individuals

\n
\n

-

\n
\n

50

\n
\n

RetrievingBasicData

\n
\n

Companies

\n
\n

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

\n
\n

51

\n
\n

IdentifyingControllingEntities

\n
\n

Companies

\n
\n

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

\n
\n

52

\n
\n

RetrievingExtendedData

\n
\n

Companies

\n
\n

Retrieving extended company data, if available

\n
\n

53

\n
\n

DownloadingCompanyDocuments

\n
\n

Companies

\n
\n

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

\n
\n

54

\n
\n

IdentifyingBeneficialOwners

\n
\n

Companies

\n
\n

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

\n
\n

55

\n
\n

PreparingChildren

\n
\n

Companies

\n
\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)

\n
\n

56

\n
\n

CheckingListedEntities

\n
\n

Companies

\n
\n

Checking for market listed entities

\n
\n

57-99

\n
\n

Reserved

\n
\n

Companies

\n
\n\n

 

\n
\n

100

\n
\n

PerformingAmlChecks

\n
\n

Individuals

\n
\n

Performing Individual AML Checks

\n
\n

101

\n
\n

PerformingAddressChecks

\n
\n

Individuals

\n
\n

Performing Individual Address Checks in available Jurisdictions

\n
\n

102

\n
\n

PerformingCourtChecks

\n
\n

Individuals

\n
\n

Performing Individual Courts Data Checks in available Jurisdictions

\n
\n

103-150

\n
\n

Reserved

\n
\n

Individuals

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
" content: application/json: example: caseDetail: details: individual: caseIndividualId: 8905 firstName: John lastName: Doe countryCodeISO31662: PT country: Portugal email: phone: nationalityCountryCodeISO31662: GB nationalityCountry: United kingdom caseCommonId: 14050 creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 properties: Birth Date: '1990-01-01T00:00:00.0000000+00:00' createdDatetime: '2017-11-24T11:44:17.2200000+00:00' common: caseCommonId: 14069 caseCustomerId: 1165 customerId: 224 customerName: AndreiCo type: 2 typeString: Individual scoring: 0 complete: 0 edit: true status: Open statusChangedDatetime: statusChangedBy: statusId: caseDecision: isVisible: true creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 creatorUserName: avgybarev@gmail.com createdDatetime: '2017-11-24T13:41:58.0300000+00:00' updatedBySystem: isAMLCase: updatedByUser: customerDepartmentId: 1249 customerDepartmentName: Management countryRisk: 4.77 assignedUserId: assignedUserName: 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: postcode: 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.8930000+00:00' '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Internal Error timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied get: summary: Individuals description: Gets individuals list operationId: 5bdacf5a13f9403fd9df848b parameters: - name: createdDateFrom in: query description: Start time at which the case was created in ISO 8601 format (YYYY-MM-DDThh:mm:ss) schema: type: string - name: createdDateTo in: query description: End time at which the case was created in ISO 8601 format (YYYY-MM-DDThh:mm:ss) schema: type: string - name: countryCodeIso31662 in: query description: ISO 31662 country code for which the cases should belong schema: type: string - name: pageSize in: query description: Size of the page schema: type: string - name: pageNumber in: query description: Page number schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: "Returns list of individual cases.\n\ncommon - case common object:\n- caseCommonId - individual case identifier in Know Your Customer web application;\n- caseCustomerId - identifier of the individual case for related customer;\n- type - case common type code.\n- typeString - case common type name. Text representation of the type;\n- complete - indicates percentage of case automatic verification process completion;\n- edit - deprecated field;\n- status - current status of the individual case, representing the case has been manually \nclosed by a user or not. Can be \"Open\" or \"Closed\";\n- statusId - representing current state of the case. Available status identifiers see in the table below.\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\n- isVisible - indicates if the individual case is visible in Know Your Customer web \n- isAMLCase - indicates should we check on anti money laundering only or not;\n- countryRisk - anti money laundering country risk score;\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\n\nisCaseAMLPositive - True if the case contains at least one AML check not excluded. False otherwise\n\nindividual - case individual object:\n- caseIndividualId - individual identifier in Know Your Customer web application;\n- firstName - individual's first name;\n- lastName - individual's last name;\n- countryCodeISO31662 - country code of individual case defined in ISO 3166-2 standard;\n- nationalityCodeISO31662 - country code of the nationality defined in ISO 3166-2 standard;\n- properties - object which can contain different set of data like Date of Birth, Occupdation, etc;\n\ncaseAddress - case address object:\n- caseAddressId - case address identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- rawAddress - address received from registry;\n- address - normalized address;\n\nAvailable case common status identifiers:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

statusId

\n
\n

Meaning

\n
\n

Applies to what Cases

\n
\n

Description

\n
\n

0

\n
\n

Initializing

\n
\n

Companies and Individuals

\n
\n

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

\n
\n

1

\n
\n

Data Collection

\n
\n

Companies and Individuals

\n
\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

\n
\n

2

\n
\n

Data Verification

\n
\n

\n

Companies and Individuals

\n

\n
\n

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

\n
\n

3

\n
\n

Ready

\n
\n

Companies and Individuals

\n\n
\n

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

\n
\n

4-49

\n
\n

Reserved

\n
\n

Companies and Individuals

\n
\n

-

\n
\n

50

\n
\n

RetrievingBasicData

\n
\n

Companies

\n
\n

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

\n
\n

51

\n
\n

IdentifyingControllingEntities

\n
\n

Companies

\n
\n

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

\n
\n

52

\n
\n

RetrievingExtendedData

\n
\n

Companies

\n
\n

Retrieving extended company data, if available

\n
\n

53

\n
\n

DownloadingCompanyDocuments

\n
\n

Companies

\n
\n

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

\n
\n

54

\n
\n

IdentifyingBeneficialOwners

\n
\n

Companies

\n
\n

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

\n
\n

55

\n
\n

PreparingChildren

\n
\n

Companies

\n
\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)

\n
\n

56

\n
\n

CheckingListedEntities

\n
\n

Companies

\n
\n

Checking for market listed entities

\n
\n

57-99

\n
\n

Reserved

\n
\n

Companies

\n
\n\n

 

\n
\n

100

\n
\n

PerformingAmlChecks

\n
\n

Individuals

\n
\n

Performing Individual AML Checks

\n
\n

101

\n
\n

PerformingAddressChecks

\n
\n

Individuals

\n
\n

Performing Individual Address Checks in available Jurisdictions

\n
\n

102

\n
\n

PerformingCourtChecks

\n
\n

Individuals

\n
\n

Performing Individual Courts Data Checks in available Jurisdictions

\n
\n

103-150

\n
\n

Reserved

\n
\n

Individuals

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
" content: application/json: example: - individual: caseIndividualId: 8905 firstName: John lastName: Doe countryCodeISO31662: PT country: Portugal email: phone: nationalityCountryCodeISO31662: GB nationalityCountry: United kingdom caseCommonId: 14050 creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 properties: Birth Date: '1990-01-01T00:00:00.0000000+00:00' createdDatetime: '2017-11-24T11:44:17.2200000+00:00' isCaseAMLPositive: true common: caseCommonId: 14069 caseCustomerId: 1165 customerId: 224 customerName: AndreiCo type: 2 typeString: Individual scoring: 0 complete: 0 edit: true status: Open statusChangedDatetime: statusChangedBy: statusId: caseDecision: Accepted isVisible: true creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 creatorUserName: avgybarev@gmail.com createdDatetime: '2017-11-24T13:41:58.0300000+00:00' updatedBySystem: isAMLCase: updatedByUser: customerDepartmentId: 1249 customerDepartmentName: Management countryRisk: 4.77 assignedUserId: assignedUserName: 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: postcode: 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.8930000+00:00' '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}': get: summary: Individual Details description: Gets individual case details operationId: 5a180a231257bc13c421bd16 parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: "Returns individual case details\n\ncommon - case common object:\n- caseCommonId - individual case identifier in Know Your Customer web application;\n- caseCustomerId - identifier of the individual case for related customer;\n- type - case common type code.\n- typeString - case common type name. Text representation of the type;\n- complete - indicates percentage of case automatic verification process completion;\n- edit - deprecated field;\n- status - current status of the individual case, representing the case has been manually\nclosed by a user or not. Can be \"Open\" or \"Closed\";\n- statusId - representing current state of the case. Available status identifiers see in the table below.\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\n- isVisible - indicates if the individual case is visible in Know Your Customer web\n- isAMLCase - indicates should we check on anti money laundering only or not;\n- countryRisk - anti money laundering country risk score;\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\n\nisCaseAMLPositive - True if the case contains at least one AML check not excluded. False otherwise\n\nindividual - case individual object:\n- caseIndividualId - individual identifier in Know Your Customer web application;\n- firstName - individual's first name;\n- lastName - individual's last name;\n- countryCodeISO31662 - country code of individual case defined in ISO 3166-2 standard;\n- nationalityCodeISO31662 - country code of the nationality defined in ISO 3166-2 standard;\n- properties - object which can contain different set of data like Date of Birth, Occupdation, etc;\n\ncaseAddress - case address object:\n- caseAddressId - case address identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- rawAddress - address received from registry;\n- address - normalized address;\n- deviceLng - longitude of user's device when verifying address;\n- deviceLat - latitude of user's device when verifying address;\n- geolocationVerified - verification result user location matches provided address. Possible values: \"Verification successful\", \"Verification failed\", \"Not Verified\" (address or user location are not specified), \"Not Available\" (geolocation feature is not included in the plan);\n\nAvailable case common status identifiers:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

statusId

\n
\n

Meaning

\n
\n

Applies to what Cases

\n
\n

Description

\n
\n

0

\n
\n

Initializing

\n
\n

Companies and Individuals

\n
\n

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

\n
\n

1

\n
\n

Data Collection

\n
\n

Companies and Individuals

\n
\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

\n
\n

2

\n
\n

Data Verification

\n
\n

\n

Companies and Individuals

\n

\n
\n

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

\n
\n

3

\n
\n

Ready

\n
\n

Companies and Individuals

\n\n
\n

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

\n
\n

4-49

\n
\n

Reserved

\n
\n

Companies and Individuals

\n
\n

-

\n
\n

50

\n
\n

RetrievingBasicData

\n
\n

Companies

\n
\n

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

\n
\n

51

\n
\n

IdentifyingControllingEntities

\n
\n

Companies

\n
\n

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

\n
\n

52

\n
\n

RetrievingExtendedData

\n
\n

Companies

\n
\n

Retrieving extended company data, if available

\n
\n

53

\n
\n

DownloadingCompanyDocuments

\n
\n

Companies

\n
\n

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

\n
\n

54

\n
\n

IdentifyingBeneficialOwners

\n
\n

Companies

\n
\n

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

\n
\n

55

\n
\n

PreparingChildren

\n
\n

Companies

\n
\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)

\n
\n

56

\n
\n

CheckingListedEntities

\n
\n

Companies

\n
\n

Checking for market listed entities

\n
\n

57-99

\n
\n

Reserved

\n
\n

Companies

\n
\n\n

 

\n
\n

100

\n
\n

PerformingAmlChecks

\n
\n

Individuals

\n
\n

Performing Individual AML Checks

\n
\n

101

\n
\n

PerformingAddressChecks

\n
\n

Individuals

\n
\n

Performing Individual Address Checks in available Jurisdictions

\n
\n

102

\n
\n

PerformingCourtChecks

\n
\n

Individuals

\n
\n

Performing Individual Courts Data Checks in available Jurisdictions

\n
\n

103-150

\n
\n

Reserved

\n
\n

Individuals

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n" content: application/json: example: caseDetail: details: individual: caseIndividualId: 8905 firstName: John lastName: Doe countryCodeISO31662: PT country: Portugal email: phone: nationalityCountryCodeISO31662: GB nationalityCountry: United kingdom caseCommonId: 14050 creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 properties: Birth Date: '1990-01-01T00:00:00.0000000+00:00' createdDatetime: '2017-11-24T11:44:17.2200000+00:00' isCaseAMLPositive: true common: caseCommonId: 14069 caseCustomerId: 1165 customerId: 224 customerName: AndreiCo type: 2 typeString: Individual scoring: 0 complete: 0 edit: true status: Open statusChangedDatetime: statusChangedBy: statusId: caseDecision: Accepted isVisible: true creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 creatorUserName: avgybarev@gmail.com createdDatetime: '2017-11-24T13:41:58.0300000+00:00' updatedBySystem: isAMLCase: updatedByUser: customerDepartmentId: 1249 customerDepartmentName: Management countryRisk: 4.77 assignedUserId: assignedUserName: 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: postcode: 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.8930000+00:00' deviceLng: -10.1248091 deviceLat: 41.4994791 geolocationVerified: Verification successful '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied delete: summary: Remove Individual Case description: 'Removes individual case ' operationId: 5cdbba1256b01802c059d487 parameters: - name: caseCommonId in: path description: Case common identifier required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Success message content: application/json: example: message: Case deleted successfully '400': description: Invalid request parameters / Access denied content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: 'Invalid request: Delete case: access denied.' timeStamp: '2019-05-15T07:35:39.0000000+00:00' '/companies/{caseCommonId}/properties': post: summary: Create/Update Company Case Properties description: Creates new company case properties or update existing with same data type and returns array of existing company case properties operationId: 5a421c561257bc0ca8459627 parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Body should contain array of case properties you want to create/update. Case property object contains:\n- dataType - case property data type;\n- data - case property data.\n\nYou can create case property with data type existing in the system or new one.\n\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." content: application/json: example: - dataType: Activity Type data: Any type - dataType: Other Names data: Test Limited responses: '200': description: Return all case properties for particular company case. content: application/json: example: - dataType: Activity Type data: Any type - dataType: Other Names data: Test Limited '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied get: summary: Get Company Case Properties description: Gets company case properties operationId: 5a4219cf1257bc0ca8459625 parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Returns array of company case properties. content: application/json: example: - dataType: Other Names data: Test Company Limited '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}/properties': post: summary: Create/Update Individual Case Properties description: Creates new individual case properties or update existing with same data type and returns array of existing individual case properties operationId: 5a4220901257bc0ca8459628 parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Body should contain array of case properties you want to create/update. Case property object contains:\n- dataType - case property data type;\n- data - case property data.\n\nYou can create case property with data type existing in the system or new one.\n\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." content: application/json: example: - dataType: Birth Date data: '1990-01-01T00:00:00.0000000+00:00' responses: '200': description: Return all case properties for particular individual case. content: application/json: example: - dataType: Birth Date data: '2000-01-01T00:00:00.0000000+00:00' '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied get: summary: Get Individual Case Properties description: Gets individual case properties operationId: 5a421b361257bc0ca8459626 parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Returns array of individual case properties. content: application/json: example: - dataType: Birth Date data: '2000-01-01T00:00:00.0000000+00:00' '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied /properties/dataTypes: get: summary: Get Data Types description: Gets distinct data types of case properties existing in the system. operationId: 5a4215061257bc0ca8459623 parameters: - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Return distinct datatypes of case properties existing in the system that could be used to create new properties records. content: application/json: example: - Birth Date - Nationality - Creation Date - Activity Type - Company Status - Company Type - Appointed on - Occupations - Registration Number - Incorporation Date - Last Accounts Date - Next Accounts Date - Records Date - Date of Incorporation - Dissolution Date - Other Names - 'National Country ID ' - Passport Country - Passport Number - National Country ID - Postal Code - TradeMark - Phone - VAT - USA State - Email - ID / Registration Number - Name - Fax Number - Identity Type - Capital - Law - Other Identifers - Total Share Capital - Other Identifiers '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/companies/{caseCommonId}/documents/mandatory': get: summary: Get Mandatory Documents For Company Case description: Gets mandatory documents for company case operationId: 5a4cf0191257bc0f544bda4f parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Returns array mandatory documents categories content: application/json: example: - NEWINC '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}/documents/mandatory': get: summary: Get Mandatory Documents For Individual Case description: Gets mandatory documents for individual case operationId: 5a4cf3c01257bc0f544bda50 parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Returns array mandatory documents categories content: application/json: example: - photoid '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied /companies/import: post: summary: Import Company Case description: Imports company case operationId: 5a5861341257bc0aa819a424 parameters: - name: ApiKey in: header description: '' required: true schema: type: string requestBody: 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:

\nentityName - the company name. Optional field;
\ncodeiso31662 - country ISO 3166-2 code. Optional field;
\ncompanyType - the company type. See possible values in the list below. Optional field;
\nproperties - array of the company properties, has same request body structure as described on POST /companies/caseCommonId/properties endpoint. Optional field;
\njourneyName - Name of the journey. Optional field;
\naddress - the object described company address. Mandatory field
\naddress can include the following properties:\n\n \n \n \n \n \n \n \n \n\t\n \n \n \n \n\t\n \n \n \n \n\t\n \n \n \n \n\t\n \n \n \n \n\t\n \n \n \n \n\t\n \n \n \n \n\t\n \n \n \n \n\t\n \n \n \n \n \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
\n\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.\n\nPossible company types:\n" content: application/json: example: entityName: TEST AIR SERVICES LTD codeiso31662: GB companyType: Private company limited by shares address: codeiso31662: GB rawAddress: '96 96 Pelhurst Road, Ryde, Isle Of Wight, England' properties: - dataType: Company Status data: Active - dataType: Registration Number data: 11111111 journeyName: All responses: '200': description: "Return imported company case details:\n\ncommon - case common object:\n- caseCommonId - newly created company case identifier in Know Your Customer web application;\n- caseCustomerId - identifier of the company case for related customer;\n- type - case common type code.\n- typeString - case common type name. Text representation of the type. Can be \"Company\" or \"Individual\";\n- complete - indicates percentage of case automatic verification process completion;\n-edit - deprecated field;\n- status - current status of the company case, representing the case has been manually \nclosed by a user or not. Can be \"Open\" or \"Closed\";\n- statusId - representing current state of the case. Available status identifiers see in the table below.\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\n- isVisible - indicates if the company case is visible in Know Your Customer web \n- isAMLCase - indicates should we check on anti money laundering only or not;\n- countryRisk - anti money laundering country risk score;\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\n\ncompany - case company object:\n- caseCompanyId - company identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- type - type of business entity;\n- properties - object which can contain different set of data depending from jurisdiction and registry. Will be empty for this operation.\n\ncaseAddress - case address object:\n- caseAddressId - case address identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- rawAddress - address received from registry;\n- address - normalized address;\n\nAvailable case common status identifiers:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

statusId

\n
\n

Meaning

\n
\n

Applies to what Cases

\n
\n

Description

\n
\n

0

\n
\n

Initializing

\n
\n

Companies and Individuals

\n
\n

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

\n
\n

1

\n
\n

Data Collection

\n
\n

Companies and Individuals

\n
\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

\n
\n

2

\n
\n

Data Verification

\n
\n

\n

Companies and Individuals

\n

\n
\n

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

\n
\n

3

\n
\n

Ready

\n
\n

Companies and Individuals

\n\n
\n

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

\n
\n

4-49

\n
\n

Reserved

\n
\n

Companies and Individuals

\n
\n

-

\n
\n

50

\n
\n

RetrievingBasicData

\n
\n

Companies

\n
\n

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

\n
\n

51

\n
\n

IdentifyingControllingEntities

\n
\n

Companies

\n
\n

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

\n
\n

52

\n
\n

RetrievingExtendedData

\n
\n

Companies

\n
\n

Retrieving extended company data, if available

\n
\n

53

\n
\n

DownloadingCompanyDocuments

\n
\n

Companies

\n
\n

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

\n
\n

54

\n
\n

IdentifyingBeneficialOwners

\n
\n

Companies

\n
\n

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

\n
\n

55

\n
\n

PreparingChildren

\n
\n

Companies

\n
\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)

\n
\n

56

\n
\n

CheckingListedEntities

\n
\n

Companies

\n
\n

Checking for market listed entities

\n
\n

57-99

\n
\n

Reserved

\n
\n

Companies

\n
\n\n

 

\n
\n

100

\n
\n

PerformingAmlChecks

\n
\n

Individuals

\n
\n

Performing Individual AML Checks

\n
\n

101

\n
\n

PerformingAddressChecks

\n
\n

Individuals

\n
\n

Performing Individual Address Checks in available Jurisdictions

\n
\n

102

\n
\n

PerformingCourtChecks

\n
\n

Individuals

\n
\n

Performing Individual Courts Data Checks in available Jurisdictions

\n
\n

103-150

\n
\n

Reserved

\n
\n

Individuals

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
" content: application/json: example: details: common: caseCommonId: 10001 caseCustomerId: 889 customerId: 224 customerName: YourCustomer type: 1 typeString: Company scoring: 0 complete: 0 edit: true status: Open statusChangedDatetime: statusChangedBy: statusId: 0 caseDecision: isVisible: true creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 creatorUserName: example@example.com createdDatetime: '2017-10-20T21:30:53.8630000+00:00' updatedBySystem: isAMLCase: false updatedByUser: customerDepartmentId: 1249 customerDepartmentName: Management countryRisk: 4.77 assignedUserId: assignedUserName: link: https://app.knowyourcustomer.com/casecompany/10001/detail company: id: 3777 caseCompanyId: 3777 caseCommonId: 10001 countryCodeISO31662: GB entityName: TEST AIR SERVICES LTD type: description: Case Generated from API2 userId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 createdDatetime: '2017-10-20T21:30:54.0900000+00:00' properties: { } caseAddress: caseAddressId: 9950 caseCommonId: 10001 addressLine1: addressLine2: city: stateProvince: postcode: country: countryCodeISO31662: countryId: rawAddress: address: userId: creatorName: createdDatetime: '2017-10-20T21:30:54.0930000+00:00' '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Internal Error timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}/documents': get: summary: Individual Documents description: Gets individual documents operationId: 5a7c2edf1257bc18dcd6b71b parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Return array of individual documents. content: application/json: example: - caseDocumentId: 227841 category: selfie name: Selfie link: https://kyc.azure-api.net/v2/documents/227841 - caseDocumentId: 227840 category: photoid name: Photo ID link: https://kyc.azure-api.net/v2/documents/227840 - caseDocumentId: 227842 category: poa name: Address link: https://kyc.azure-api.net/v2/documents/227842 '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '403': description: Access denied content: application/json: example: statusCode: 403 message: Access denied '/companies/{caseCommonId}/link/{childCaseCommonId}': post: summary: Link Case To Company description: Links child case to parent company case operationId: 5a7c75371257bc18dcd6b71c parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: childCaseCommonId in: path description: Child Case Common identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Object describes what type of relation should be created between child case and parent company:\n\nrelationType - relation type. Possible values described in the table below;\n\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;\n\nshares - In case if relationType is Shareholder you can provide amount of shares.\n\n\nPossible relationType values:\n\n \n \n \n \n \n \n \n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n \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
" content: application/json: example: relationType: Shareholder relationRole: Shareholder shares: 50000 responses: '200': description: "Company members structure.\n
\nAll returned member groups (controllingEntitiesAndIndividuals and shareholdersAndBeneficialOwners) can include cases for individuals and companies.\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).\n
\n\nEach member result object contains:\n- properties - object which can contain different set of data depending from jurisdiction and registry. Each registry provides different set of data.\n
Minimum dataset for company member: Company Name, Company Type,\n Company Registration Number, Company Status, Creation / Incorporation Date.\n
Minimum dataset for individual member: Individual Name, Individual Relation (Director | Secretary | Auditor | etc).\n\n- isKYCed - indicates if the particular member can be processed and verified;\n- memberType - type of the member. Can be \"Company\" or \"Individual\"." content: application/json: example: controllingEntitiesAndIndividualsTitle: Controlling Entities and Individuals controllingEntitiesAndIndividuals: - role: Partner member: firstName: Dan lastName: Linddal Bechmann ANDERSEN caseCommonId: 14150 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 38 C Søndre Alle addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: 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: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Partner member: entityName: AKTK ApS caseCommonId: 14151 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 12 Store Torvegade addressLine2: '' city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Store Torvegade 12, 3700 Rønne' address: '12 Store Torvegade, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: 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: caseCommonId: addressLine1: 2 A Elses Løkkevej addressLine2: city: Nexø stateProvince: postcode: 3730 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark' address: '2 A Elses Løkkevej, Nexø, 3730, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Partner member: firstName: Ole lastName: BONDERUP caseCommonId: 14153 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 1 Broløkke addressLine2: city: Svaneke stateProvince: postcode: 3740 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Broløkke 1 , Østermarie, 3740 Svaneke, Denmark' address: '1 Broløkke, Svaneke, 3740, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Partner member: firstName: Anders lastName: KOFOED caseCommonId: 14154 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 94 Aaker addressLine2: city: Aakirkeby stateProvince: postcode: 3720 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark' address: '94 Aaker, Aakirkeby, 3720, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Partner member: firstName: Tonny lastName: KOFOED caseCommonId: 14155 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 37 Kapelvej addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Kapelvej 37 , Rønne, 3700 Rønne, Denmark' address: '37 Kapelvej, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Director member: firstName: Dan lastName: Linddal Bechmann ANDERSEN caseCommonId: 14150 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 38 C Søndre Alle addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: 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: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - role: Director member: entityName: AKTK ApS caseCommonId: 14151 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 12 Store Torvegade addressLine2: '' city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Store Torvegade 12, 3700 Rønne' address: '12 Store Torvegade, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: 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: caseCommonId: addressLine1: 2 A Elses Løkkevej addressLine2: city: Nexø stateProvince: postcode: 3730 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark' address: '2 A Elses Løkkevej, Nexø, 3730, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false - role: Director member: firstName: Ole lastName: BONDERUP caseCommonId: 14153 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 1 Broløkke addressLine2: city: Svaneke stateProvince: postcode: 3740 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Broløkke 1 , Østermarie, 3740 Svaneke, Denmark' address: '1 Broløkke, Svaneke, 3740, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false - role: Director member: firstName: Anders lastName: KOFOED caseCommonId: 14154 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 94 Aaker addressLine2: city: Aakirkeby stateProvince: postcode: 3720 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark' address: '94 Aaker, Aakirkeby, 3720, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false - role: Director member: firstName: Tonny lastName: KOFOED caseCommonId: 14155 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 37 Kapelvej addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Kapelvej 37 , Rønne, 3700 Rønne, Denmark' address: '37 Kapelvej, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: 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: caseCommonId: addressLine1: 94 Aaker addressLine2: city: Aakirkeby stateProvince: postcode: 3720 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Søndre Landevej 94 , Aaker, 3720 Aakirkeby, Denmark' address: '94 Aaker, Aakirkeby, 3720, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - shares: 27 member: firstName: Tonny lastName: KOFOED caseCommonId: 14155 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 37 Kapelvej addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Kapelvej 37 , Rønne, 3700 Rønne, Denmark' address: '37 Kapelvej, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: true - shares: 0 member: firstName: Dan lastName: Linddal Bechmann ANDERSEN caseCommonId: 14150 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 38 C Søndre Alle addressLine2: city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: 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: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false - shares: 0 member: entityName: AKTK ApS caseCommonId: 14151 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 12 Store Torvegade addressLine2: '' city: Rønne stateProvince: postcode: 3700 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Store Torvegade 12, 3700 Rønne' address: '12 Store Torvegade, Rønne, 3700, Denmark' userId: creatorName: createdDatetime: 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: caseCommonId: addressLine1: 2 A Elses Løkkevej addressLine2: city: Nexø stateProvince: postcode: 3730 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Elses Løkkevej 2 A , Snogebæk, 3730 Nexø, Denmark' address: '2 A Elses Løkkevej, Nexø, 3730, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false - shares: 0 member: firstName: Ole lastName: BONDERUP caseCommonId: 14153 jurisdictionId: 62 codeISO31662: DK address: caseAddressId: caseCommonId: addressLine1: 1 Broløkke addressLine2: city: Svaneke stateProvince: postcode: 3740 country: Denmark countryCodeISO31662: countryId: 62 rawAddress: 'Broløkke 1 , Østermarie, 3740 Svaneke, Denmark' address: '1 Broløkke, Svaneke, 3740, Denmark' userId: creatorName: createdDatetime: properties: { } memberType: Individual isKYCed: false '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '403': description: Access denied content: application/json: example: statusCode: 403 message: Access denied '/companies/{caseCommonId}/properties/{dataType}': delete: summary: Remove Company Case Property description: Removes company case property by data type. operationId: 5a4222311257bc0ca8459629 parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: dataType in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Return all case properties for particular company case. content: application/json: example: - dataType: Activity Type data: Any type - dataType: Other Names data: Test Limited '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid DataType timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}/properties/{dataType}': delete: summary: Remove Individual Case Property description: Removes individual case property by data type. operationId: 5a422a1a1257bc0ca845962a parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: dataType in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Return all case properties for particular individual case. content: application/json: example: - dataType: Birth Date data: '2000-01-01T00:00:00.0000000+00:00' '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid DataType timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/companies/{caseCommonId}/documents/request': post: summary: Request Company Case Documents 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 parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string requestBody: 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.\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;\n- email - optional email address to receive email with access code and link to upload portal;\n- phone - optional phone number to reveive SMS with access code to upload reqeusted documents using mobile application.\n- allowEdit - optional paramether that allow edit/add company information." content: application/json: example: documents: - NEWINC - Annual Accounts email: example@example.com phone: '' allowEdit: true responses: '200': description: "Response contains the following data:\n- uploadUrl - link to portal to upload requested documents;\n- accessCode - access code which should be provided during uploading documents using both upload portal and mobile application;\n- emailSent - indicates if email was sent;\n- smsSent - indicates if SMS was sent." content: application/json: example: uploadUrl: https://dev.kycl.io/upload/+A00000 accessCode: +A00000 emailSent: true smsSent: false '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}/documents/request': post: summary: Request Individual Case Documents 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 parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string requestBody: 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.\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;\n- email - optional email address to receive email with access code and link to upload portal;\n- phone - optional phone number to reveive SMS with access code to upload reqeusted documents using mobile application.\n- allowEdit - optional paramether that allow to edit/add individual information." content: application/json: example: documents: - photoid email: '' phone: '' allowEdit: true responses: '200': description: "Response contains the following data:\n- uploadUrl - link to portal to upload requested documents;\n- accessCode - access code which should be provided during uploading documents using both upload portal and mobile application;\n- emailSent - indicates if email was sent;\n- smsSent - indicates if SMS was sent." content: application/json: example: uploadUrl: https://dev.kycl.io/upload/+A00000 accessCode: +A00000 emailSent: false smsSent: false '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/companies/{caseCommonId}/documents/upload': post: summary: Upload Document To Company Case description: Uploads the document to company case. operationId: 5a58882f1257bc0aa819a425 parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Request body includes file you wanted to upload and form-data to describe uploaded document.\n\nDocument data:
\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;\n\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;\n\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." content: multipart/form-data: { } responses: '200': description: Uploaded document result content: application/json: example: 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 content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid API Key timeStamp: '2017-07-28T14:15:51.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}/documents/upload': post: summary: Upload Document To Individual Case description: Uploads the document to Individual case. operationId: 5a589e401257bc0aa819a426 parameters: - name: caseCommonId in: path description: '' required: true schema: type: string - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Request body includes file you wanted to upload and form-data to describe uploaded document.\n\nDocument data:
\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;\n\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;\n\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." content: multipart/form-data: { } responses: '200': description: Uploaded document result content: application/json: example: caseCommonId: 16627 caseDocumentId: 93349 category: photoid name: Photo ID link: https://kyc.azure-api.net/v2/documents/93349 '400': description: Invalid request parameters or photo id pre-validation failed content: application/json: example: statusCode: 400 message: Api Errors apiErrors: - description: Face not recognized on document timeStamp: '2019-04-25T12:19:30.0000000+00:00' - description: Identity document not recognized timeStamp: '2019-04-25T12:19:30.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied /individuals/import: post: summary: Import Individual Case description: Import a new individual case operationId: 5af35097049b5e1e7cb9059c parameters: - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Individual data.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n \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
" content: application/json: example: firstName: John lastName: Doe nationalityCodeiso31662: GB birthDate: '1980-01-01T00:00:00.0000000+00:00' addressLine1: addressLine2: postcode: city: province: countryCodeiso31662: properties: - dataType: BirthDate data: '1990-01-01T00:00:00.0000000+00:00' journeyName: All responses: '200': description: "Return created individual case details:\n\ncommon - case common object:\n- caseCommonId - individual case identifier in Know Your Customer web application;\n- caseCustomerId - identifier of the individual case for related customer;\n- type - case common type code.\n- typeString - case common type name. Text representation of the type;\n- complete - indicates percentage of case automatic verification process completion;\n- edit - deprecated field;\n- status - current status of the individual case, representing the case has been manually \nclosed by a user or not. Can be \"Open\" or \"Closed\";\n- statusId - representing current state of the case. Available status identifiers see in the table below.\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\n- isVisible - indicates if the individual case is visible in Know Your Customer web \n- isAMLCase - indicates should we check on anti money laundering only or not;\n- countryRisk - anti money laundering country risk score;\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\n\nindividual - case individual object:\n- caseIndividualId - individual identifier in Know Your Customer web application;\n- firstName - individual's first name;\n- lastName - individual's last name;\n- countryCodeISO31662 - country code of individual case defined in ISO 3166-2 standard;\n- nationalityCodeISO31662 - country code of the nationality defined in ISO 3166-2 standard;\n- properties - object which can contain different set of data like Date of Birth, Occupdation, etc;\n\ncaseAddress - case address object:\n- caseAddressId - case address identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- rawAddress - address received from registry;\n- address - normalized address;\n\nAvailable case common status identifiers:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

statusId

\n
\n

Meaning

\n
\n

Applies to what Cases

\n
\n

Description

\n
\n

0

\n
\n

Initializing

\n
\n

Companies and Individuals

\n
\n

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

\n
\n

1

\n
\n

Data Collection

\n
\n

Companies and Individuals

\n
\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

\n
\n

2

\n
\n

Data Verification

\n
\n

\n

Companies and Individuals

\n

\n
\n

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

\n
\n

3

\n
\n

Ready

\n
\n

Companies and Individuals

\n\n
\n

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

\n
\n

4-49

\n
\n

Reserved

\n
\n

Companies and Individuals

\n
\n

-

\n
\n

50

\n
\n

RetrievingBasicData

\n
\n

Companies

\n
\n

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

\n
\n

51

\n
\n

IdentifyingControllingEntities

\n
\n

Companies

\n
\n

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

\n
\n

52

\n
\n

RetrievingExtendedData

\n
\n

Companies

\n
\n

Retrieving extended company data, if available

\n
\n

53

\n
\n

DownloadingCompanyDocuments

\n
\n

Companies

\n
\n

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

\n
\n

54

\n
\n

IdentifyingBeneficialOwners

\n
\n

Companies

\n
\n

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

\n
\n

55

\n
\n

PreparingChildren

\n
\n

Companies

\n
\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)

\n
\n

56

\n
\n

CheckingListedEntities

\n
\n

Companies

\n
\n

Checking for market listed entities

\n
\n

57-99

\n
\n

Reserved

\n
\n

Companies

\n
\n\n

 

\n
\n

100

\n
\n

PerformingAmlChecks

\n
\n

Individuals

\n
\n

Performing Individual AML Checks

\n
\n

101

\n
\n

PerformingAddressChecks

\n
\n

Individuals

\n
\n

Performing Individual Address Checks in available Jurisdictions

\n
\n

102

\n
\n

PerformingCourtChecks

\n
\n

Individuals

\n
\n

Performing Individual Courts Data Checks in available Jurisdictions

\n
\n

103-150

\n
\n

Reserved

\n
\n

Individuals

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
" content: application/json: example: caseDetail: details: individual: caseIndividualId: 8905 firstName: John lastName: Doe countryCodeISO31662: PT country: Portugal email: phone: nationalityCountryCodeISO31662: GB nationalityCountry: United kingdom caseCommonId: 14050 creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 properties: Birth Date: '1990-01-01T00:00:00.0000000+00:00' createdDatetime: '2017-11-24T11:44:17.2200000+00:00' common: caseCommonId: 14069 caseCustomerId: 1165 customerId: 224 customerName: AndreiCo type: 2 typeString: Individual scoring: 0 complete: 0 edit: true status: Open statusChangedDatetime: statusChangedBy: statusId: caseDecision: isVisible: true creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 creatorUserName: avgybarev@gmail.com createdDatetime: '2017-11-24T13:41:58.0300000+00:00' updatedBySystem: isAMLCase: updatedByUser: customerDepartmentId: 1249 customerDepartmentName: Management countryRisk: 4.77 assignedUserId: assignedUserName: 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: postcode: 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.8930000+00:00' '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Internal Error timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}/link/{childCaseCommonId}': post: summary: Link Individual Case To Individual description: Links individual child case to parent individual case. operationId: 5abde14d049b5e19fce1a103 parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: childCaseCommonId in: path description: Child Case Common identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Object describes what type of relation should be created between child case and parent individual:\n\nrelationType - relation type. Possible values described in the table below.\n\nPossible relationType values:\n\n \n \n \n \n \n \n \n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n \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
" content: application/json: example: relationType: Agent responses: '200': description: Return new created relationship description. content: application/json: example: success: true relationshipDescriptions: - Sibling '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '403': description: Access denied content: application/json: example: statusCode: 403 message: Access denied '/companies/{caseCommonId}/identity': put: summary: Update Company description: Update existing company identity information. operationId: 5af2ed13049b5e10c0c830b8 parameters: - name: caseCommonId in: path description: '' required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Company data.\n\n \n\t\t\n\t\t\t\n \n \n\t\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\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
" content: application/json: example: codeiso31662: GB entityName: UNITED ACCESS SERVICES LIMITED entityType: Company companyType: Private company limited by shares addressLine1: Green st. addressLine2: 10 postcode: 385493 city: Garlem countryCodeiso31662: IE responses: '200': description: "Return created company case details:\n\ncommon - case common object:\n- caseCommonId - newly created company case identifier in Know Your Customer web application;\n- caseCustomerId - identifier of the company case for related customer;\n- type - case common type code.\n- typeString - case common type name. Text representation of the type. Can be \"Company\" or \"Individual\";\n- complete - indicates percentage of case automatic verification process completion;\n-edit - deprecated field;\n- status - current status of the company case, representing the case has been manually \nclosed by a user or not. Can be \"Open\" or \"Closed\";\n- statusId - represents current state of the case. Available status identifiers see in the table below.\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\n- isVisible - indicates if the company case is visible in Know Your Customer web \n- isAMLCase - indicates should we check on anti money laundering only or not;\n- countryRisk - anti money laundering country risk score;\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\n- caseProcessingType - case processing type, \"\" for regular case processing, \"Lite\" for KYC Lite cases;\n\ncompany - case company object:\n- caseCompanyId - company identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- type - type of business entity;\n- properties - object which can contain different set of data depending from jurisdiction and registry. Will be empty for this operation.\n\ncaseAddress - case address object:\n- caseAddressId - case address identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- rawAddress - address received from registry;\n- address - normalized address;\n\nAvailable case common status identifiers:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

statusId

\n
\n

Meaning

\n
\n

Applies to what Cases

\n
\n

Description

\n
\n

0

\n
\n

Initializing

\n
\n

Companies and Individuals

\n
\n

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

\n
\n

1

\n
\n

Data Collection

\n
\n

Companies and Individuals

\n
\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

\n
\n

2

\n
\n

Data Verification

\n
\n

\n

Companies and Individuals

\n

\n
\n

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

\n
\n

3

\n
\n

Ready

\n
\n

Companies and Individuals

\n\n
\n

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

\n
\n

4-49

\n
\n

Reserved

\n
\n

Companies and Individuals

\n
\n

-

\n
\n

50

\n
\n

RetrievingBasicData

\n
\n

Companies

\n
\n

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

\n
\n

51

\n
\n

IdentifyingControllingEntities

\n
\n

Companies

\n
\n

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

\n
\n

52

\n
\n

RetrievingExtendedData

\n
\n

Companies

\n
\n

Retrieving extended company data, if available

\n
\n

53

\n
\n

DownloadingCompanyDocuments

\n
\n

Companies

\n
\n

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

\n
\n

54

\n
\n

IdentifyingBeneficialOwners

\n
\n

Companies

\n
\n

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

\n
\n

55

\n
\n

PreparingChildren

\n
\n

Companies

\n
\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)

\n
\n

56

\n
\n

CheckingListedEntities

\n
\n

Companies

\n
\n

Checking for market listed entities

\n
\n

57-99

\n
\n

Reserved

\n
\n

Companies

\n
\n\n

 

\n
\n

100

\n
\n

PerformingAmlChecks

\n
\n

Individuals

\n
\n

Performing Individual AML Checks

\n
\n

101

\n
\n

PerformingAddressChecks

\n
\n

Individuals

\n
\n

Performing Individual Address Checks in available Jurisdictions

\n
\n

102

\n
\n

PerformingCourtChecks

\n
\n

Individuals

\n
\n

Performing Individual Courts Data Checks in available Jurisdictions

\n
\n

103-150

\n
\n

Reserved

\n
\n

Individuals

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
" content: application/json: example: caseDetail: details: common: caseCommonId: 10001 caseCustomerId: 889 customerId: 224 customerName: YourCustomer type: 1 typeString: Company scoring: 0 complete: 0 edit: true status: Open statusChangedDatetime: statusChangedBy: statusId: 0 caseDecision: isVisible: true creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 creatorUserName: example@example.com createdDatetime: '2017-10-20T21:30:53.8630000+00:00' updatedBySystem: isAMLCase: false updatedByUser: customerDepartmentId: 1249 customerDepartmentName: Management countryRisk: 4.77 assignedUserId: assignedUserName: link: https://app.knowyourcustomer.com/casecompany/10001/detail caseProcessingType: '' company: id: 3777 caseCompanyId: 3777 caseCommonId: 10001 countryCodeISO31662: GB entityName: TEST AIR SERVICES LTD type: description: Case Generated from API2 userId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 createdDatetime: '2017-10-20T21:30:54.0900000+00:00' properties: { } caseAddress: caseAddressId: 9950 caseCommonId: 10001 addressLine1: addressLine2: city: stateProvince: postcode: country: countryCodeISO31662: countryId: rawAddress: address: userId: creatorName: createdDatetime: '2017-10-20T21:30:54.0930000+00:00' '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Internal Error timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}/identity': put: summary: Update Individual Case description: Update an existing individual case operationId: 5af2efbb049b5e10c0c830b9 parameters: - name: caseCommonId in: path required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Individual data.\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\t\n \n \n \n \n\t\n \n \n \n \n\t\n \n \n \n \n\t\n \n \n \n \n \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
deviceLnglongitude of user's device when verifying addressNo
deviceLatlatitude of user's device when verifying addressNo
" content: application/json: example: firstName: John lastName: Doe nationalityCodeiso31662: GB birthDate: '1980-01-01T00:00:00.0000000+00:00' addressLine1: addressLine2: postcode: city: province: countryCodeiso31662: properties: - dataType: BirthDate data: '1990-01-01T00:00:00.0000000+00:00' journeyName: All responses: '200': description: "Return created individual case details:\n\ncommon - case common object:\n- caseCommonId - individual case identifier in Know Your Customer web application;\n- caseCustomerId - identifier of the individual case for related customer;\n- type - case common type code.\n- typeString - case common type name. Text representation of the type;\n- complete - indicates percentage of case automatic verification process completion;\n- edit - deprecated field;\n- status - current status of the individual case, representing the case has been manually \nclosed by a user or not. Can be \"Open\" or \"Closed\";\n- statusId - representing current state of the case. Available status identifiers see in the table below.\n- caseDecision - final decision made for a closed case, either \"Accepted\" or \"Denied\". If case is still open, null is returned.\n- isVisible - indicates if the individual case is visible in Know Your Customer web \n- isAMLCase - indicates should we check on anti money laundering only or not;\n- countryRisk - anti money laundering country risk score;\n- customerDepartmentId - identifier of the cusotmer's department in Know Your Customer web application;\n\nindividual - case individual object:\n- caseIndividualId - individual identifier in Know Your Customer web application;\n- firstName - individual's first name;\n- lastName - individual's last name;\n- countryCodeISO31662 - country code of individual case defined in ISO 3166-2 standard;\n- nationalityCodeISO31662 - country code of the nationality defined in ISO 3166-2 standard;\n- properties - object which can contain different set of data like Date of Birth, Occupdation, etc;\n\ncaseAddress - case address object:\n- caseAddressId - case address identifier in Know Your Customer web application;\n- countryCodeISO31662 - country code defined in ISO 3166-2 standard;\n- rawAddress - address received from registry;\n- address - normalized address;\n- deviceLng - longitude of user's device when verifying address;\n- deviceLat - latitude of user's device when verifying address;\n- geolocationVerified - verification result user location matches provided address. Possible values: \"Verification successful\", \"Verification failed\", \"Not Verified\" (address or user location are not specified), \"Not Available\" (geolocation feature is not included in the plan);\n\nAvailable case common status identifiers:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n

statusId

\n
\n

Meaning

\n
\n

Applies to what Cases

\n
\n

Description

\n
\n

0

\n
\n

Initializing

\n
\n

Companies and Individuals

\n
\n

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

\n
\n

1

\n
\n

Data Collection

\n
\n

Companies and Individuals

\n
\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

\n
\n

2

\n
\n

Data Verification

\n
\n

\n

Companies and Individuals

\n

\n
\n

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

\n
\n

3

\n
\n

Ready

\n
\n

Companies and Individuals

\n\n
\n

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

\n
\n

4-49

\n
\n

Reserved

\n
\n

Companies and Individuals

\n
\n

-

\n
\n

50

\n
\n

RetrievingBasicData

\n
\n

Companies

\n
\n

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

\n
\n

51

\n
\n

IdentifyingControllingEntities

\n
\n

Companies

\n
\n

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

\n
\n

52

\n
\n

RetrievingExtendedData

\n
\n

Companies

\n
\n

Retrieving extended company data, if available

\n
\n

53

\n
\n

DownloadingCompanyDocuments

\n
\n

Companies

\n
\n

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

\n
\n

54

\n
\n

IdentifyingBeneficialOwners

\n
\n

Companies

\n
\n

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

\n
\n

55

\n
\n

PreparingChildren

\n
\n

Companies

\n
\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)

\n
\n

56

\n
\n

CheckingListedEntities

\n
\n

Companies

\n
\n

Checking for market listed entities

\n
\n

57-99

\n
\n

Reserved

\n
\n

Companies

\n
\n\n

 

\n
\n

100

\n
\n

PerformingAmlChecks

\n
\n

Individuals

\n
\n

Performing Individual AML Checks

\n
\n

101

\n
\n

PerformingAddressChecks

\n
\n

Individuals

\n
\n

Performing Individual Address Checks in available Jurisdictions

\n
\n

102

\n
\n

PerformingCourtChecks

\n
\n

Individuals

\n
\n

Performing Individual Courts Data Checks in available Jurisdictions

\n
\n

103-150

\n
\n

Reserved

\n
\n

Individuals

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
\n\n

 

\n
" content: application/json: example: caseDetail: details: individual: caseIndividualId: 8905 firstName: John lastName: Doe countryCodeISO31662: PT country: Portugal email: phone: nationalityCountryCodeISO31662: GB nationalityCountry: United kingdom caseCommonId: 14050 creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 properties: Birth Date: '1990-01-01T00:00:00.0000000+00:00' createdDatetime: '2017-11-24T11:44:17.2200000+00:00' common: caseCommonId: 14069 caseCustomerId: 1165 customerId: 224 customerName: AndreiCo type: 2 typeString: Individual scoring: 0 complete: 0 edit: true status: Open statusChangedDatetime: statusChangedBy: statusId: caseDecision: isVisible: true creatorId: db557fed-99b5-4c8a-b3c9-5d2d42d2bc13 creatorUserName: avgybarev@gmail.com createdDatetime: '2017-11-24T13:41:58.0300000+00:00' updatedBySystem: isAMLCase: updatedByUser: customerDepartmentId: 1249 customerDepartmentName: Management countryRisk: 4.77 assignedUserId: assignedUserName: 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: postcode: 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.8930000+00:00' deviceLng: -10.1248091 deviceLat: 41.4994791 geolocationVerified: Verification successful '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Internal Error timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied /companyTypes: get: summary: Company Types description: Get available company types operationId: 5b84e90ff664c597254ec0cd parameters: - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Returns list of the available jurisdictions content: application/json: example: - Branch - Company limited by guarantee - Consortium - Cooperative - Corporation - External company - Foreign branch - Foreign Companie - Foreign subsidiary company - Foundation - General partnership - Government owned with variable capital and variable shareholders - Incorporated - Investment company - Limited Liability Company - Limited liability cooperative - Limited liability foundation - Limited Liability Limited Partnership - Limited Liability Partnerships - Limited Partnership - Limited partnership - ILP - Limited partnership - LLP - Limited partnership - LP - Madras - Management Corporation - Mosque - National Association - National Trust and Savings Association - News Bureau - Other/Non-corporate - Other/Partnership - Private company - Private company limited by guarantee without share capital - Private company limited by shares - Private foundation - Professional Limited Liability Company - Property management company - Public Accounting Firm - Public company - Public Company Limited by Guarantee - Public company limited by shares - Register of Commerce and Companies - Sole proprietorship - State-owned enterprise - Trade Union - Trust - Undetermined - Unlimited company '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid API Key timeStamp: '2017-07-28T14:15:51.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/companies/{caseCommonId}/amlchecks': get: summary: Company AML Checks description: Gets the AML Check results for the selected company operationId: 5bed8b6c24ff61cef6216e33 parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: "Returns all AML Check entries found in the case and not excluded\n\ncompany - case common details:\n- caseCommonId - company case identifier in Know Your Customer web application;\n- lastName - the name of the company;\n\nworldChecks - all AML entries found in WorldCheck. Each entity has the following properties:\n- category - the type of company (e.g. CORPORATE, BANK, etc.);\n- firstName - always empty;\n- lastName - the name of the company found in Worldcheck;\n- dateOfBirth - always empty;\n- placeOfBirth - always empty;\n- citizenship - country in which the company operates;\n- aliases - other possible names for the company;\n- entered - date in which the entry was added in WorldCheck;\n- externalMediaFound - links to additional information about the entry;\n- furtherInformation - additional information about the entry;\n- locations - additional details about the location in which the entry was added;\n\nlexisNexisChecks - all AML entries found in LexisNexis. Each entity has the following properties:\n- category - the type of AML entry (e.g. PEP, ADVERSEMEDIA, etc.);\n- firstName - always empty;\n- lastName - the name of the company found in Worldcheck;\n- dateOfBirth - always empty;\n- placeOfBirth - always empty;\n- occupation - always empty;\n- entered - date in which the entry was added in WorldCheck;\n- associations - additional information about the entry;\n" content: application/json: example: company: caseCommonId: 100921 lastName: TESTING COMPANY worldChecks: - category: CORPORATE firstName: '' lastName: TESTING COMPANY dateOfBirth: '' placeOfBirth: '' citizenship: INDONESIA aliases: ALIAS COMPANY entered: '2002-02-08T00:00:00.0000000+00:00' 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: placeOfBirth: occupation: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc sapien quam, tempor nec ipsum a.' entered: '2016-08-04T00:00:00.0000000+00:00' associations: 'Wife (PEP:Govt Branch Member): Testing, Name, 1328143,Relative (PEP:Govt Branch Member): Name, Test Other, 124531' '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}/amlchecks': get: summary: Individual AML Checks description: Gets AML Check results for the selected case operationId: 5bed8a736951ef71f349d631 parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: "Returns all AML Check entries found in the case and not excluded\n\nindividual - case common details:\n- caseCommonId - company case identifier in Know Your Customer web application;\n- lastName - the last name of the person;\n- firstName - the first name of the person;\n\nworldChecks - all AML entries found in WorldCheck. Each entity has the following properties:\n- category - the type of AML entry (e.g. INDIVIDUAL, TERRORISM, LEGAL, etc.);\n- firstName - the first name of the person;\n- lastName - the last name of the person;\n- dateOfBirth - the date in which person was born;\n- placeOfBirth - the location in which person was born;\n- citizenship - the citizenship of hte person;\n- aliases - other names found for the person;\n- entered - date in which the entry was added in WorldCheck;\n- externalMediaFound - links to additional information about the entry;\n- furtherInformation - additional information about the entry;\n- locations - additional details about the location in which the entry was added;\n\nlexisNexisChecks - all AML entries found in LexisNexis. Each entity has the following properties:\n- category - the type of AML entry (e.g. INDIVIDUAL, TERRORISM, LEGAL, etc.);\n- firstName the first name of the person;\n- lastName - the last name of the person;\n- dateOfBirth - the date in which person was born;\n- placeOfBirth - the location in which person was born;\n- occupation - the occupation of the person;\n- entered - date in which the entry was added in WorldCheck;\n- associations - additional information about the entry;\n" content: application/json: example: individual: caseCommonId: 14456 lastName: Testing firstName: Individual worldChecks: - category: LEGAL firstName: Testing I lastName: Indivdual dateOfBirth: '' placeOfBirth: '' citizenship: USA aliases: '' entered: '2010-08-24T00:00:00.0000000+00:00' 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 content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/casesteps/{caseCommonId}/details/{stepId}': get: summary: Case Step Details description: Gets full details for an existing case step. operationId: 5c798f7d723e87f88505448d parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: stepId in: path description: Case Step identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: "Returns basic step properties as in Get Steps action plus additional Details field that is different for different steps.\n\n- name - the name of the step;\n- caseStepId - the step id;\n- isDeletable - indicates if the step can be deleted;\n- isProcessed - indicates if the step is processed;\n- isExcluded - indicates if the step is excluded (false for non Aml match cases);\n- isCollapsed - indicates if the step is collapsed;\n- isLoading - indicates if the step is loading;\n- hasNotes - indicates if the step has notes;\n- createdDatetime - step creation time ;\n- updateDatetime - step updated time;\n- type - step type;\n- status - step status (PASSED, FAILED, NOTREVIEWED);\n\nDetails\n\nDetails for Proof of Identity step\n- FaceVerification\n- IsVerified - boolean result if verification finished successful;\n- Confidence - confidence score of comparison (1-100);\n- Message - reason of verification failure ;\n- CreatedDatetime - datetime of face verification;\n- Documents - a list of:\n - Category - category of the document;\n - DocumentAvailable - indicate if document(s) is available(i .e uploaded or not);\n - VerificationStatus - \"Not Verified\", \"Verification successful\", \"Verification failed\";\n - CaseDocumentID - unique identifier for the document ;\n - Name - name of the document;\n - Link - link to document location, if document is available ;\n - VerificationDetails - Section with document verification details\n - Success - boolean result if verification finished successfully\n - TriggeredRule - pattern which applied to make decision based on verification result\n - Result - validation result. Possible values 'Valid', 'Warning', 'Fail'\n - Message - validation status, e.g. DocumentPassedAuthentication\n - Sensitivity - document verification sensitivity\n - Decision - possible values 'Verified', 'Deviated', 'Expired', 'RequiresFurtherReview', 'PotentialForgery'\n - Properties - rule properties\n - FailUpload - document upload status\n - ImageQuality - image quality description\n - Percentage - measure of image quality. Can take values from 0 to 100\n - Value - image quality group. Possible values: VeryLow, Low, Average, High, Perfect\n - ForgeryTests - a list of forgery tests:\n - Group - group of the test. Can take values 'Data Integrity', 'Digital', 'Structure', 'Visible'\n - Type - type of the test\n - Result -test result. Can take values Authenticated, Failed, Forged, Unconclusive, UnableToComplete, NotRelevant\n - IdentityReport - identity information\n - FirstName - first name\n - LastName - last name\n - BirthDate - birth date\n - SourceDocument - document type, e.g. 'Passport'\n - BirthPlace - birth place\n - ExpiryDate - document expiry date\n - DocumentNumber - document number\n - DocumentCountryOfOrigin - country of document's origin\n - Address - address\n - Message - status message of verification report\n\nDetails for Aml match step of Individual case\n- category - the type of AML entry (e.g. INDIVIDUAL, TERRORISM, LEGAL, etc.);\n- firstName - the first name of the person;\n- lastName - the last name of the person;\n- dateOfBirth - the date in which person was born;\n- placeOfBirth - the location in which person was born;\n- citizenship - the citizenship of the person;\n- aliases - other names found for the person;\n- entered - date in which the entry was added in WorldCheck;\n- externalMediaFound - links to additional information about the entry;\n- furtherInformation - additional information about the entry;\n- locations - additional details about the location in which the entry was added;\n- biography - the biography of the person;\n- identification - the identification of the person;\n- reports - reports for the person;\n\nDetails for Search results step\n- ResultsCount - the number of search results;\n- Documents - a list of:\n- Title - search result title;\n- Url - search result url;\n\nDetails for step with documents e.g. Proof of address\n- Documents - a list of:\n- Category - category of the document;\n- DocumentAvailable - indicate if document(s) is available(i .e uploaded or not);\n- VerificationStatus - \"Not Verified\", \"Verification successful\", \"Verification failed\";\n- CaseDocumentID - unique identifier for the document ;\n- Name - name of the document;\n- Link - link to document location, if document is available ;" content: application/json: example: Name: Anti-money laundering CaseStepId: 1496943 IsDeletable: true IsProcessed: true IsExcluded: true IsCollapsed: false IsLoading: false HasNotes: false CreatedDatetime: '2019-02-14T14:51:28.3330000+00:00' UpdateDatetime: '2019-02-20T09:53:59.7970000+00:00' Type: TEXT Status: PASSED Details: Category: DIPLOMAT FirstName: Mayuma Teresa LastName: AFONSO DateOfBirth: '' PlaceOfBirth: '' Citizenship: ANGOLA Aliases: 'ANDRE,Mayuma Teresa;ANDR?,Mayuma Teresa' Entered: '2008-02-08T00:00:00.0000000+00:00' ExternalMediaFound: http://w01.international.gc.ca/Protocol/pdf/DrsBook_2008_01_eng.pdf http://www.dges.mctes.pt/NR/rdonlyres/57AE85E4-C93E-405D-B94F-79F26576A8EA/6473/LivroCorpoDiplomaticoAcreditado.pdf http://www.portugal.gov.pt/media/1498918/livro-corpo-diplomatico-2014-agosto.pdf FurtherInformation: '[BIOGRAPHY] Financial Attach? to Portugal (reported Feb 2012 - ). Attach? to Canada (reported Jan 2008). [IDENTIFICATION] To be determined. [REPORTS] Aug 2015 - no further information reported.' Locations: '~ Faro, Faro ~ PORTUGAL;~ Ottawa, Ontario ~ CANADA;~,~ ANGOLA' Biography: Financial Attach? to Portugal (reported Feb 2012 - ). Attach? to Canada (reported Jan 2008). Identification: To be determined. Reports: Aug 2015 - no further information reported. '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/casesteps/{caseCommonId}': get: summary: Case Steps description: Gets list of visible steps for a case. operationId: 5c798d3befd616c1e775825a parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: "Returns a list of all visible steps for a case in the displayed order grouped by Step Group.\n\nEach step contains:\n- name - the name of the step;\n- caseStepId - the step id;\n- isDeletable - indicates if the step can be deleted;\n- isProcessed - indicates if the step is processed;\n- isExcluded - indicates if the step is excluded (false for non Aml match cases);\n- isCollapsed - indicates if the step is collapsed;\n- isLoading - indicates if the step is loading;\n- hasNotes - indicates if the step has notes;\n- createdDatetime - step creation time ;\n- updateDatetime - step updated time;\n- type - step type;\n- status - step status (PASSED, FAILED, NOTREVIEWED);" content: application/json: example: - group: Identity steps: - name: Proof of Identity caseStepId: 1496924 isDeletable: true isProcessed: true isExcluded: false isCollapsed: false isLoading: false hasNotes: false createdDatetime: '2019-02-14T14:48:52.5430000+00:00' updateDatetime: '2019-02-26T22:24:39.8330000+00:00' type: TEXT status: PASSED - name: Government Photo ID caseStepId: 1496925 isDeletable: true isProcessed: true isExcluded: false isCollapsed: false isLoading: false hasNotes: false createdDatetime: '2019-02-14T14:48:52.5430000+00:00' updateDatetime: '2019-02-18T19:15:02.8970000+00:00' type: TEXT status: PASSED - name: Proof of address caseStepId: 1496926 isDeletable: true isProcessed: true isExcluded: false isCollapsed: true isLoading: false hasNotes: false createdDatetime: '2019-02-14T14:48:52.5430000+00:00' updateDatetime: '2019-02-18T18:59:47.0200000+00:00' type: TEXT status: PASSED - name: Your Loan Documents caseStepId: 1504858 isDeletable: false isProcessed: true isExcluded: false isCollapsed: true isLoading: false hasNotes: false createdDatetime: '2019-02-21T10:14:34.7070000+00:00' updateDatetime: type: DOCUMENT status: PASSED - name: Anti-money laundering caseStepId: 1496942 isDeletable: true isProcessed: true isExcluded: false isCollapsed: false isLoading: false hasNotes: false createdDatetime: '2019-02-14T14:51:27.7400000+00:00' updateDatetime: '2019-02-22T10:09:43.3700000+00:00' type: TEXT status: PASSED - name: Anti-money laundering caseStepId: 1496943 isDeletable: true isProcessed: true isExcluded: true isCollapsed: false isLoading: false hasNotes: false createdDatetime: '2019-02-14T14:51:28.3330000+00:00' updateDatetime: '2019-02-20T09:53:59.7970000+00:00' type: TEXT status: PASSED - name: Search Results caseStepId: 1496964 isDeletable: true isProcessed: true isExcluded: false isCollapsed: true isLoading: false hasNotes: false createdDatetime: '2019-02-14T14:52:10.4730000+00:00' updateDatetime: type: TEXT status: PASSED '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/companies/{caseCommonId}/status': patch: summary: Close/Reopen Company Case description: Close or reopen an existing company case operationId: 5ca71c30d0e164bfcd4a6118 parameters: - name: caseCommonId in: path required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameDescriptionMandatory
status\"Open\" or \"Closed\"Yes
\n\n

Only Open and 100% Completed cases can be closed\".

\n

Only Closed cases can be reopened.

" content: application/json: example: status: Closed responses: '200': description: Returns same result as Individual Details action. content: application/json: { } '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Internal Error timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}/status': patch: summary: Close/Reopen Individual Case description: Close or reopen an existing individual case operationId: 5c7973fa922d5899d50b9406 parameters: - name: caseCommonId in: path required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameDescriptionMandatory
status\"Open\" or \"Closed\"Yes
\n\n

Only Open and 100% Completed cases can be closed\".

\n

Only Closed cases can be reopened.

" content: application/json: example: status: Closed responses: '200': description: Returns same result as Individual Details action. content: application/json: { } '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Internal Error timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied /casecomments/: post: summary: Create Case Comment description: Creates new case comment and return bool operationId: create-case-comment parameters: - name: ApiKey in: header schema: type: string requestBody: description: Body should contain model of case comment that you want to create. content: application/json: example: CaseCommonId: 123456 Comment: Some comment responses: '200': description: Return true\false content: application/json: { } '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/casecomments/{caseCommentId}': delete: summary: Delete Case Comment description: Removes case comment by case comment id. operationId: delete-case-comment parameters: - name: caseCommentId in: path required: true schema: type: number - name: ApiKey in: header schema: type: string responses: '200': description: Returns true\false content: application/json: { } '400': description: '' content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid DataType timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: '' content: application/json: example: statusCode: 401 message: Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API. '403': description: '' content: application/json: example: statusCode: 403 message: Access denied '/casesteps/{caseCommonId}/exclude/{stepId}': patch: summary: Exclude Aml Step description: Exclude or include back an existing Aml match step operationId: 5c798ba3e79dec5417587c12 parameters: - name: caseCommonId in: path required: true schema: type: number - name: stepId in: path required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameDescriptionMandatory
isExcludedboolean to change Excluded state of the Aml match stepYes
" content: application/json: example: isExcluded: false responses: '200': description: Returns same result as step in single result of Case Steps action. content: application/json: { } '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Internal Error timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied /casecomments: get: summary: Get Case Comments description: Get case comments by case commonId operationId: get-case-comments parameters: - name: caseCommonId in: query description: Case Common identifier required: true schema: type: number - name: ApiKey in: header schema: type: string responses: '200': description: "Returns case common \n" content: application/json: example: - CaseCommentId: 123 CaseCommonId: 123456 Comment: Some comment CreationDate: '2019-02-14T14:51:28.3330000+00:00' Author: This guy IsAbleToDelete: true - CaseCommentId: 124 CaseCommonId: 123456 Comment: Another comment CreationDate: '2019-02-14T14:51:28.3330000+00:00' Author: Another guy IsAbleToDelete: false '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/casesteps/{caseCommonId}/status/{stepId}': patch: summary: Update Step Status description: Update status of an existing step operationId: 5c797d9fd5b796b8d7cc11bb parameters: - name: caseCommonId in: path required: true schema: type: number - name: stepId in: path required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
NameDescriptionMandatory
statusPASSED, FAILED or NOTREVIEWEDNo
isCollapsedboolean to change Collapsed state of the stepNo
" content: application/json: example: status: Passed isCollapsed: false responses: '200': description: Returns same result as step in single result of Case Steps action. content: application/json: { } '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Internal Error timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/CaseStepNotes/{caseCommonId}/{stepId}': post: summary: Add Case Step Note description: Creates new note for a case step operationId: 5cc172283bd6ff88aa6d3759 parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: stepId in: path description: Step identifier required: true schema: type: number - name: ApiKey in: header schema: type: string requestBody: description: Body should contain model of case note that you want to create. content: application/json: example: Note: Some note responses: '200': description: Returns note that has just been created content: application/json: example: id: 428 username: someuser@samplehost.net createdDateTime: '2019-04-25T08:59:19.7159891+00:00' note: Some note '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/casestepnotes/{caseCommonId}/{stepId}': get: summary: Case Step Notes description: Gets list of notes for a case step operationId: 5cc14677615f13d44801f9b2 parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: stepId in: path description: Step identifier required: true schema: type: number - name: ApiKey in: header description: '' required: true schema: type: string responses: '200': description: Returns a list of all notes for a case step specified content: application/json: example: - id: 412 username: user1@host.com createdDateTime: '2019-04-14T12:45:17.6930000+00:00' note: some note text - id: 415 username: user2@otherhost.net createdDateTime: '2019-04-14T13:03:46.4070000+00:00' note: another note text '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied delete: summary: Delete Case Step Notes description: Deletes case step notes operationId: 5cc171cacbe1d0be23563eec parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: stepId in: path description: Step identifier required: true schema: type: number - name: ApiKey in: header schema: type: string requestBody: description: Body should contain array of case step note's IDs to be deleted content: application/json: example: - 231 - 481 responses: '200': description: Returns a list of notes left after current operation content: application/json: example: - id: 412 username: user1@host.com createdDateTime: '2019-04-14T12:45:17.6930000+00:00' note: some note text - id: 415 username: user2@otherhost.net createdDateTime: '2019-04-14T13:03:46.4070000+00:00' note: another note text '400': description: '' content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid DataType timeStamp: '2017-07-28T12:26:21.0000000+00:00' '401': description: '' content: application/json: example: statusCode: 401 message: Access denied due to missing subscription key. Make sure to include subscription key when making requests to an API. '403': description: '' content: application/json: example: statusCode: 403 message: Access denied '/companies/{caseCommonId}/audittrail': get: summary: Get Company Audit Trail description: "Get audit trail for company case.\n\nThe audit trail is the immutable list of steps and actions your users or the system has taken in order to verify a case. All entries are time stamped for accurate record keeping." operationId: 5cc151ff5bf57072e961f67e parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: ApiKey in: header required: true schema: type: string responses: '200': description: "Returns list of audit trail objects\n" content: application/json: example: - createdOn: '2019-04-16T14:22:32.7870000+00:00' message: New KYC case number D0-D-132513 created for Sheila Ann Somerset linked to case D0-D-132303 on 2019-04-16 14:22:32 - createdOn: '2019-04-16T14:21:39.9170000+00:00' message: New incoming link to this case D0-D-132303 from case D0-D-132510 for Paul Raymond Davies on 2019-04-16 14:21:39 - createdOn: '2019-04-16T14:21:28.6630000+00:00' message: New KYC case number D0-D-132503 created for John Carter linked to case D0-D-132303 on 2019-04-16 14:21:28 '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied '/individuals/{caseCommonId}/audittrail': get: summary: Get Individual Audit Trail description: "Get audit trail for individual case.\n\nThe audit trail is the immutable list of steps and actions your users or the system has taken in order to verify a case. All entries are time stamped for accurate record keeping." operationId: 5cc14d882dacf8fd9e5aff29 parameters: - name: caseCommonId in: path description: Case Common identifier required: true schema: type: number - name: ApiKey in: header required: true schema: type: string responses: '200': description: "Returns list of audit trail objects\n" content: application/json: example: - createdOn: '2019-04-16T14:22:32.7870000+00:00' message: New KYC case number D0-D-132513 created for Sheila Ann Somerset linked to case D0-D-132303 on 2019-04-16 14:22:32 - createdOn: '2019-04-16T14:21:39.9170000+00:00' message: New incoming link to this case D0-D-132303 from case D0-D-132510 for Paul Raymond Davies on 2019-04-16 14:21:39 - createdOn: '2019-04-16T14:21:28.6630000+00:00' message: New KYC case number D0-D-132503 created for John Carter linked to case D0-D-132303 on 2019-04-16 14:21:28 '400': description: Invalid request parameters content: application/json: example: statusCode: 400 message: Api Error apiErrors: - description: Invalid CaseCommonId timeStamp: '2017-07-25T12:26:21.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied /individuals/documents/prevalidate: post: summary: Pre-validate Document for Individual Case description: Pre-validates document for Individual case. operationId: 5cc817529a25ae3c882422aa parameters: - name: ApiKey in: header description: '' required: true schema: type: string requestBody: description: "Request body includes file you want to upload and form-data to describe uploaded document. PhotoId and selfie pre-validation is supported at the moment.\n\nDocument data:
\nfileCat - category of the file you want to upload. Should take photoid or selfie value. Mandatory field;\n\nname - document name. Mandatory field;\n" content: multipart/form-data: { } responses: '200': description: Array of validation errors. Empty if no errors found. content: application/json: example: - Low resolution '400': description: Invalid request parameters or photo id pre-validation failed content: application/json: example: statusCode: 400 message: Api Errors apiErrors: - description: Face not recognized on document timeStamp: '2019-04-25T12:19:30.0000000+00:00' - description: Identity document not recognized timeStamp: '2019-04-25T12:19:30.0000000+00:00' '401': description: Missing subscription key content: application/json: example: 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 content: application/json: example: statusCode: 403 message: Access denied components: securitySchemes: apiKeyHeader: type: apiKey name: Ocp-Apim-Subscription-Key in: header apiKeyQuery: type: apiKey name: subscription-key in: query security: - apiKeyHeader: [ ] - apiKeyQuery: [ ] x-ms-export-notes: - 'The exported API contains schemas that aren''t of content type ''application/vnd.oai.openapi.components+json'', and are hence not exported as OpenAPI components.'