Download OpenAPI specification:
KYC related API for Aptic solutions
| $filter | string Filter conditions specified in a simplified OData format |
| $skip | integer <int32> List offset when paginating (default 0) |
| $top | integer <int32> Maximum size of result (default 25, max 100) |
| $orderby | string Sorting conditions E.g. "fullname desc" |
{- "count": 0,
- "skip": 0,
- "total": 0,
- "value": [
- {
- "creditInformationGuid": "string",
- "regDate": "2019-08-24T14:15:22Z",
- "userCode": "string",
- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "infoAvailable": true,
- "idNumber": "string",
- "fullName": "string",
- "street": "string",
- "houseNo": "string",
- "houseNoExtension": "string",
- "city": "string",
- "stateCode": "string",
- "zipCode": "string",
- "countryCode": "string",
- "decision": "string",
- "internalCode": "string",
- "internalRating": "string",
- "userFriendlyRating": "string",
- "scoring": "string",
- "riskForecast": "string",
- "creditLimit": 0.1,
- "creditClass": "string"
}
]
}Credit information
| customerGuid | string or null Guid of the customer the credit information regards |
| clientGuid | string or null Guid of the client the credit information regards |
| debtorGuid | string or null Guid of the debtor the credit information regards |
| manuallyRegistered | boolean True if the credit information was manually registered |
| providerCode | string or null Code for the provider of the credit information |
| provider | string or null Provider of the credit information |
| infoAvailable | boolean or null Information available |
| idNumber | string or null Company number/SSN of the credit information |
| fullName | string or null Name of the person/company of the credit information |
| birthName | string or null Birth name of the person of the credit information |
| salutation | string or null Salutation/title of the person of the credit information |
| firstName | string or null First name of the person of the credit information |
| initials | string or null Initials of the person of the credit information |
| middleName | string or null Middle name of the person of the credit information |
| infix | string or null Infix of the person of the credit information |
| lastName | string or null Last name of the person of the credit information |
| nameSuffix | string or null Name suffix of the person of the credit information |
| birthDate | string or null <date-time> Birth date of the person of the credit information |
| gender | integer or null <int32> Gender of the person of the credit information 0 = Female 1 = Male |
| street | string or null Street of the address of the credit information |
| houseNo | string or null House number of the address of the credit information |
| houseNoExtension | string or null House number extension of the address of the credit information |
| city | string or null City of the address of the credit information |
| stateCode | string or null State code of the address of the credit information |
| zipCode | string or null Zip code of the address of the credit information |
| countryCode | string or null Country of the address of the credit information |
| decision | string or null Decision based on the credit information |
| internalCode | string or null Internal decision code based on the credit information |
| internalRating | string or null Internal rating based on the credit information |
| userFriendlyRating | string or null User friendly rating based on the credit information |
| scoring | string or null Scoring based on the credit information |
| riskForecast | string or null Risk forecast based on the credit information |
| creditLimit | number or null <double> Credit limit based on the credit information |
| creditClass | string or null Credit class based on the credit information |
| templateName | string or null Name of the template used by the credit information provider |
| sniCode | string or null SNI/NACE branch code based on the credit information |
| mortgageSumCompany | number or null <double> Company mortgage summary based on the credit information |
| mortgageSumBankrupt | number or null <double> Bankrupt claim summary based on the credit information |
| bankruptSolicitor | string or null Bankrupt solicitor |
| applications | integer or null <int32> Number of applications at the bailiff |
| applicationSum | number or null <double> Total amount of the applications at the bailiff |
| countGovernmentCases | integer or null <int32> Number of government cases at the bailiff |
| sumGovernmentCases | number or null <double> Summary of government cases at the bailiff |
| countPrivateCases | integer or null <int32> Number of private cases at the bailiff |
| sumPrivateCases | number or null <double> Summary of private cases at the bailiff |
| propertyAssessedValueSum | number or null <double> Property assessed value sum |
| propertyAssessedValuePart | number or null <double> Part of the assessed property value |
| propertyNumber | integer or null <int32> Number of properties |
| yearOfAssessement | integer or null <int32> Year for the property assessement |
| profitActiveBusiness | number or null <double> Profit from active bussiness |
| profitPassiveBusiness | number or null <double> Profit from passive bussiness |
| profitEmployment | number or null <double> Profit/income as an employment |
| profitCapital | number or null <double> Profit from invested capital (interest) |
| lossCapital | number or null <double> Loss from invested capital (interest) |
| taxAllowance | number or null <double> Tax allowance |
| assessedSalary | number or null <double> Taxable assessed salary |
| taxableWealth | number or null <double> Taxable wealth |
| vat | number or null <double> VAT |
| excessVAT | number or null <double> Excess vat |
| finalTax | number or null <double> Final tax |
| lossWealth | number or null <double> Loss wealth |
| taxableWealthExemptAmount | number or null <double> Taxable wealth exempt amount |
| operationsIncome | number or null <double> Operations income |
| equity | number or null <double> Equity of the business |
| solidity | number or null <double> Solidity of the business |
| causeCodes | string or null Cause codes for the credit decision |
| inquiryReport | string or null Inquiry report code at the bailiff |
| inquiryReportDate | string or null <date-time> Date for the latest inquiry report at the bailiff |
| distraintSalary | number or null <double> Distraint salary |
| yearOfSalary | integer or null <int32> Year of salary |
| turnover | number or null <double> Turnover |
| outcome | number or null <double> Outcome |
| surveillanceCategory | integer or null <int32> Surveillance category |
| municipalCode | string or null Municipal code |
object or null Details regarding the economic calculation | |
| economicCalculationNetAmount | number or null <double> The net amount from the economic calculation |
| creditInfoNumber | integer or null <int32> The net amount from the economic calculation |
| userNote | string or null Free text note by the user regarding the credit information |
| note | string or null Free text note regarding the credit information |
object or null Custom data for the credit information |
{- "customerGuid": "string",
- "clientGuid": "string",
- "debtorGuid": "string",
- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "infoAvailable": true,
- "idNumber": "string",
- "fullName": "string",
- "birthName": "string",
- "salutation": "string",
- "firstName": "string",
- "initials": "string",
- "middleName": "string",
- "infix": "string",
- "lastName": "string",
- "nameSuffix": "string",
- "birthDate": "2019-08-24T14:15:22Z",
- "gender": 0,
- "street": "string",
- "houseNo": "string",
- "houseNoExtension": "string",
- "city": "string",
- "stateCode": "string",
- "zipCode": "string",
- "countryCode": "string",
- "decision": "string",
- "internalCode": "string",
- "internalRating": "string",
- "userFriendlyRating": "string",
- "scoring": "string",
- "riskForecast": "string",
- "creditLimit": 0.1,
- "creditClass": "string",
- "templateName": "string",
- "sniCode": "string",
- "mortgageSumCompany": 0.1,
- "mortgageSumBankrupt": 0.1,
- "bankruptSolicitor": "string",
- "applications": 0,
- "applicationSum": 0.1,
- "countGovernmentCases": 0,
- "sumGovernmentCases": 0.1,
- "countPrivateCases": 0,
- "sumPrivateCases": 0.1,
- "propertyAssessedValueSum": 0.1,
- "propertyAssessedValuePart": 0.1,
- "propertyNumber": 0,
- "yearOfAssessement": 0,
- "profitActiveBusiness": 0.1,
- "profitPassiveBusiness": 0.1,
- "profitEmployment": 0.1,
- "profitCapital": 0.1,
- "lossCapital": 0.1,
- "taxAllowance": 0.1,
- "assessedSalary": 0.1,
- "taxableWealth": 0.1,
- "vat": 0.1,
- "excessVAT": 0.1,
- "finalTax": 0.1,
- "lossWealth": 0.1,
- "taxableWealthExemptAmount": 0.1,
- "operationsIncome": 0.1,
- "equity": 0.1,
- "solidity": 0.1,
- "causeCodes": "string",
- "inquiryReport": "string",
- "inquiryReportDate": "2019-08-24T14:15:22Z",
- "distraintSalary": 0.1,
- "yearOfSalary": 0,
- "turnover": 0.1,
- "outcome": 0.1,
- "surveillanceCategory": 0,
- "municipalCode": "string",
- "economicCalculation": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "economicCalculationNetAmount": 0.1,
- "creditInfoNumber": 0,
- "userNote": "string",
- "note": "string",
- "data": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}| creditInfoGuid required | string Credit guid |
{- "creditInformationGuid": "string",
- "regDate": "2019-08-24T14:15:22Z",
- "userCode": "string",
- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "infoAvailable": true,
- "idNumber": "string",
- "fullName": "string",
- "birthName": "string",
- "salutation": "string",
- "firstName": "string",
- "initials": "string",
- "middleName": "string",
- "infix": "string",
- "lastName": "string",
- "nameSuffix": "string",
- "birthDate": "2019-08-24T14:15:22Z",
- "gender": 0,
- "street": "string",
- "houseNo": "string",
- "houseNoExtension": "string",
- "city": "string",
- "stateCode": "string",
- "zipCode": "string",
- "countryCode": "string",
- "decision": "string",
- "internalCode": "string",
- "internalRating": "string",
- "userFriendlyRating": "string",
- "scoring": "string",
- "riskForecast": "string",
- "creditLimit": 0.1,
- "creditClass": "string",
- "templateName": "string",
- "sniCode": "string",
- "mortgageSumCompany": 0.1,
- "mortgageSumBankrupt": 0.1,
- "bankruptSolicitor": "string",
- "applications": 0,
- "applicationSum": 0.1,
- "countGovernmentCases": 0,
- "sumGovernmentCases": 0.1,
- "countPrivateCases": 0,
- "sumPrivateCases": 0.1,
- "propertyAssessedValueSum": 0.1,
- "propertyAssessedValuePart": 0.1,
- "propertyNumber": 0,
- "yearOfAssessement": 0,
- "profitActiveBusiness": 0.1,
- "profitPassiveBusiness": 0.1,
- "profitEmployment": 0.1,
- "profitCapital": 0.1,
- "lossCapital": 0.1,
- "taxAllowance": 0.1,
- "assessedSalary": 0.1,
- "taxableWealth": 0.1,
- "vat": 0.1,
- "excessVAT": 0.1,
- "finalTax": 0.1,
- "lossWealth": 0.1,
- "taxableWealthExemptAmount": 0.1,
- "operationsIncome": 0.1,
- "equity": 0.1,
- "solidity": 0.1,
- "causeCodes": "string",
- "inquiryReport": "string",
- "inquiryReportDate": "2019-08-24T14:15:22Z",
- "distraintSalary": 0.1,
- "yearOfSalary": 0,
- "turnover": 0.1,
- "outcome": 0.1,
- "surveillanceCategory": 0,
- "municipalCode": "string",
- "economicCalculation": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "economicCalculationNetAmount": 0.1,
- "creditInfoNumber": 0,
- "userNote": "string",
- "note": "string",
- "data": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}| creditInfoGuid required | string Credit information guid |
Credit information
| manuallyRegistered | boolean True if the credit information was manually registered |
| providerCode | string or null Code for the provider of the credit information |
| provider | string or null Provider of the credit information |
| infoAvailable | boolean or null Information available |
| idNumber | string or null Company number/SSN of the credit information |
| fullName | string or null Name of the person/company of the credit information |
| birthName | string or null Birth name of the person of the credit information |
| salutation | string or null Salutation/title of the person of the credit information |
| firstName | string or null First name of the person of the credit information |
| initials | string or null Initials of the person of the credit information |
| middleName | string or null Middle name of the person of the credit information |
| infix | string or null Infix of the person of the credit information |
| lastName | string or null Last name of the person of the credit information |
| nameSuffix | string or null Name suffix of the person of the credit information |
| birthDate | string or null <date-time> Birth date of the person of the credit information |
| gender | integer or null <int32> Gender of the person of the credit information 0 = Female 1 = Male |
| street | string or null Street of the address of the credit information |
| houseNo | string or null House number of the address of the credit information |
| houseNoExtension | string or null House number extension of the address of the credit information |
| city | string or null City of the address of the credit information |
| stateCode | string or null State code of the address of the credit information |
| zipCode | string or null Zip code of the address of the credit information |
| countryCode | string or null Country of the address of the credit information |
| decision | string or null Decision based on the credit information |
| internalCode | string or null Internal decision code based on the credit information |
| internalRating | string or null Internal rating based on the credit information |
| userFriendlyRating | string or null User friendly rating based on the credit information |
| scoring | string or null Scoring based on the credit information |
| riskForecast | string or null Risk forecast based on the credit information |
| creditLimit | number or null <double> Credit limit based on the credit information |
| creditClass | string or null Credit class based on the credit information |
| templateName | string or null Name of the template used by the credit information provider |
| sniCode | string or null SNI/NACE branch code based on the credit information |
| mortgageSumCompany | number or null <double> Company mortgage summary based on the credit information |
| mortgageSumBankrupt | number or null <double> Bankrupt claim summary based on the credit information |
| bankruptSolicitor | string or null Bankrupt solicitor |
| applications | integer or null <int32> Number of applications at the bailiff |
| applicationSum | number or null <double> Total amount of the applications at the bailiff |
| countGovernmentCases | integer or null <int32> Number of government cases at the bailiff |
| sumGovernmentCases | number or null <double> Summary of government cases at the bailiff |
| countPrivateCases | integer or null <int32> Number of private cases at the bailiff |
| sumPrivateCases | number or null <double> Summary of private cases at the bailiff |
| propertyAssessedValueSum | number or null <double> Property assessed value sum |
| propertyAssessedValuePart | number or null <double> Part of the assessed property value |
| propertyNumber | integer or null <int32> Number of properties |
| yearOfAssessement | integer or null <int32> Year for the property assessement |
| profitActiveBusiness | number or null <double> Profit from active bussiness |
| profitPassiveBusiness | number or null <double> Profit from passive bussiness |
| profitEmployment | number or null <double> Profit/income as an employment |
| profitCapital | number or null <double> Profit from invested capital (interest) |
| lossCapital | number or null <double> Loss from invested capital (interest) |
| taxAllowance | number or null <double> Tax allowance |
| assessedSalary | number or null <double> Taxable assessed salary |
| taxableWealth | number or null <double> Taxable wealth |
| vat | number or null <double> VAT |
| excessVAT | number or null <double> Excess vat |
| finalTax | number or null <double> Final tax |
| lossWealth | number or null <double> Loss wealth |
| taxableWealthExemptAmount | number or null <double> Taxable wealth exempt amount |
| operationsIncome | number or null <double> Operations income |
| equity | number or null <double> Equity of the business |
| solidity | number or null <double> Solidity of the business |
| causeCodes | string or null Cause codes for the credit decision |
| inquiryReport | string or null Inquiry report code at the bailiff |
| inquiryReportDate | string or null <date-time> Date for the latest inquiry report at the bailiff |
| distraintSalary | number or null <double> Distraint salary |
| yearOfSalary | integer or null <int32> Year of salary |
| turnover | number or null <double> Turnover |
| outcome | number or null <double> Outcome |
| surveillanceCategory | integer or null <int32> Surveillance category |
| municipalCode | string or null Municipal code |
object or null Details regarding the economic calculation | |
| economicCalculationNetAmount | number or null <double> The net amount from the economic calculation |
| creditInfoNumber | integer or null <int32> The net amount from the economic calculation |
| userNote | string or null Free text note by the user regarding the credit information |
| note | string or null Free text note regarding the credit information |
object or null Custom data for the credit information |
{- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "infoAvailable": true,
- "idNumber": "string",
- "fullName": "string",
- "birthName": "string",
- "salutation": "string",
- "firstName": "string",
- "initials": "string",
- "middleName": "string",
- "infix": "string",
- "lastName": "string",
- "nameSuffix": "string",
- "birthDate": "2019-08-24T14:15:22Z",
- "gender": 0,
- "street": "string",
- "houseNo": "string",
- "houseNoExtension": "string",
- "city": "string",
- "stateCode": "string",
- "zipCode": "string",
- "countryCode": "string",
- "decision": "string",
- "internalCode": "string",
- "internalRating": "string",
- "userFriendlyRating": "string",
- "scoring": "string",
- "riskForecast": "string",
- "creditLimit": 0.1,
- "creditClass": "string",
- "templateName": "string",
- "sniCode": "string",
- "mortgageSumCompany": 0.1,
- "mortgageSumBankrupt": 0.1,
- "bankruptSolicitor": "string",
- "applications": 0,
- "applicationSum": 0.1,
- "countGovernmentCases": 0,
- "sumGovernmentCases": 0.1,
- "countPrivateCases": 0,
- "sumPrivateCases": 0.1,
- "propertyAssessedValueSum": 0.1,
- "propertyAssessedValuePart": 0.1,
- "propertyNumber": 0,
- "yearOfAssessement": 0,
- "profitActiveBusiness": 0.1,
- "profitPassiveBusiness": 0.1,
- "profitEmployment": 0.1,
- "profitCapital": 0.1,
- "lossCapital": 0.1,
- "taxAllowance": 0.1,
- "assessedSalary": 0.1,
- "taxableWealth": 0.1,
- "vat": 0.1,
- "excessVAT": 0.1,
- "finalTax": 0.1,
- "lossWealth": 0.1,
- "taxableWealthExemptAmount": 0.1,
- "operationsIncome": 0.1,
- "equity": 0.1,
- "solidity": 0.1,
- "causeCodes": "string",
- "inquiryReport": "string",
- "inquiryReportDate": "2019-08-24T14:15:22Z",
- "distraintSalary": 0.1,
- "yearOfSalary": 0,
- "turnover": 0.1,
- "outcome": 0.1,
- "surveillanceCategory": 0,
- "municipalCode": "string",
- "economicCalculation": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "economicCalculationNetAmount": 0.1,
- "creditInfoNumber": 0,
- "userNote": "string",
- "note": "string",
- "data": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}| creditInfoGuid required | string Credit information guid |
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}| creditInfoGuid required | string Credit information guid |
| $filter | string Filter conditions specified in a simplified OData format |
| $skip | integer <int32> List offset when paginating (default 0) |
| $top | integer <int32> Maximum size of result (default 25, max 100) |
| $orderby | string Sorting conditions E.g. "fullname desc" |
{- "count": 0,
- "skip": 0,
- "total": 0,
- "value": [
- {
- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "important": true,
- "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}
]
}| creditInfoGuid required | string Credit information guid |
Document information
| note required | string non-empty Free extra information related to the document. |
| documentType | string or null Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik). |
| loggedAt | string or null <date-time> Document creation date. |
| originalFileName required | string non-empty The file name to be generated instead of an auto-generated one. |
| searchValue | string or null Document specific search value or reference number. |
| externalLink | string or null Link to the document, if it exists on external archive. |
| important | boolean or null Document importancy flag. |
| fileDataBase64 | string or null Base64-encoded file body. |
{- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "searchValue": "string",
- "externalLink": "string",
- "important": true,
- "fileDataBase64": "string"
}{- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "important": true,
- "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}| creditInfoGuid required | string Credit information guid |
| documentGuid required | string The unique GUID of the document |
{- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "important": true,
- "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}Execute custom service definition in CLVR with possibility to pass in JSON into definition.
| guid required | string Credit information guid |
| serviceDefinition required | string The invoke service definition request. |
| async | boolean Specify if custom action should be performed asynchronously |
JSON body
{- "name1": "string",
- "name2": false,
- "name3": {
- "name4": [
- "string",
- "string"
]
}
}{ }Execute custom service definition in CLVR with possibility to pass in JSON into definition.
| serviceDefinition required | string The invoke service definition request. |
| async | boolean Specify if custom action should be performed asynchronously |
JSON body
{- "name1": "string",
- "name2": false,
- "name3": {
- "name4": [
- "string",
- "string"
]
}
}{ }| $filter | string Filter conditions specified in a simplified OData format |
| $skip | integer <int32> List offset when paginating (default 0) |
| $top | integer <int32> Maximum size of result (default 25, max 100) |
| $orderby | string Sorting conditions E.g. "fullname desc" |
{- "count": 0,
- "skip": 0,
- "total": 0,
- "value": [
- {
- "kycGuid": "string",
- "regDate": "2019-08-24T14:15:22Z",
- "userCode": "string",
- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "authorizedSignatory": true,
- "identityDocumentType": 0,
- "idDocReference": "string",
- "idNumber": "string",
- "fullName": "string",
- "street": "string",
- "houseNo": "string",
- "houseNoExtension": "string",
- "city": "string",
- "stateCode": "string",
- "zipCode": "string",
- "countryCode": "string",
- "residenceCountryCode": "string",
- "pepStatus": 0,
- "ultimateBeneficialOwnerIdNumber": "string",
- "ultimateBeneficialOwnerFullname": "string",
- "note": "string"
}
]
}KYC information
| customerGuid | string or null Guid of the customer the KYC information regards |
| clientGuid | string or null Guid of the client the KYC information regards |
| debtorGuid | string or null Guid of the debtor the KYC information regards |
| manuallyRegistered | boolean True if the KYC information was manually registered |
| providerCode | string or null Code for the provider of the KYC information |
| provider | string or null Provider of the KYC information |
| authorizedSignatory | boolean or null Person is a authorized signatory |
| identityDocumentType | integer or null <int32> Type of document used for identification 1 = Passport 2 = Drivers license 3 = National identity card 4 = Birth certificate 5 = Utility bill |
| idDocReference | string or null Reference number of document used for identification |
| idNumber | string or null Company number/SSN of the person being identified |
| fullName | string or null Name of the person/company being identified |
| street | string or null Street of the address of the person being identified |
| houseNo | string or null House number of the address of the person being identified |
| houseNoExtension | string or null House number extension of the address of the person being identified |
| city | string or null City of the address of the person being identified |
| stateCode | string or null State code of the address of the person being identified |
| zipCode | string or null Zip code of the address of the person being identified |
| countryCode | string or null Country of the address of the person being identified |
| residenceCountryCode | string or null Residence country of the person being identified |
| pepStatus | integer or null <int32> If the person is a politically exposed person (or related to) 0 = No 1 = Yes 2 = Related |
| ultimateBeneficialOwnerIdNumber | string or null Company number/SSN of the ultimate beneficial owner |
| ultimateBeneficialOwnerFullname | string or null Name of the ultimate beneficial owner |
| note | string or null Free text note regarding the KYC information |
object or null Custom data for the KYC information |
{- "customerGuid": "string",
- "clientGuid": "string",
- "debtorGuid": "string",
- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "authorizedSignatory": true,
- "identityDocumentType": 0,
- "idDocReference": "string",
- "idNumber": "string",
- "fullName": "string",
- "street": "string",
- "houseNo": "string",
- "houseNoExtension": "string",
- "city": "string",
- "stateCode": "string",
- "zipCode": "string",
- "countryCode": "string",
- "residenceCountryCode": "string",
- "pepStatus": 0,
- "ultimateBeneficialOwnerIdNumber": "string",
- "ultimateBeneficialOwnerFullname": "string",
- "note": "string",
- "data": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}| kycGuid required | string KYC guid |
{- "kycGuid": "string",
- "regDate": "2019-08-24T14:15:22Z",
- "userCode": "string",
- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "authorizedSignatory": true,
- "identityDocumentType": 0,
- "idDocReference": "string",
- "idNumber": "string",
- "fullName": "string",
- "street": "string",
- "houseNo": "string",
- "houseNoExtension": "string",
- "city": "string",
- "stateCode": "string",
- "zipCode": "string",
- "countryCode": "string",
- "residenceCountryCode": "string",
- "pepStatus": 0,
- "ultimateBeneficialOwnerIdNumber": "string",
- "ultimateBeneficialOwnerFullname": "string",
- "note": "string",
- "data": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}| kycGuid required | string KYC guid |
KYC information
| manuallyRegistered | boolean True if the KYC information was manually registered |
| providerCode | string or null Code for the provider of the KYC information |
| provider | string or null Provider of the KYC information |
| authorizedSignatory | boolean or null Person is a authorized signatory |
| identityDocumentType | integer or null <int32> Type of document used for identification 1 = Passport 2 = Drivers license 3 = National identity card 4 = Birth certificate 5 = Utility bill |
| idDocReference | string or null Reference number of document used for identification |
| idNumber | string or null Company number/SSN of the person being identified |
| fullName | string or null Name of the person/company being identified |
| street | string or null Street of the address of the person being identified |
| houseNo | string or null House number of the address of the person being identified |
| houseNoExtension | string or null House number extension of the address of the person being identified |
| city | string or null City of the address of the person being identified |
| stateCode | string or null State code of the address of the person being identified |
| zipCode | string or null Zip code of the address of the person being identified |
| countryCode | string or null Country of the address of the person being identified |
| residenceCountryCode | string or null Residence country of the person being identified |
| pepStatus | integer or null <int32> If the person is a politically exposed person (or related to) 0 = No 1 = Yes 2 = Related |
| ultimateBeneficialOwnerIdNumber | string or null Company number/SSN of the ultimate beneficial owner |
| ultimateBeneficialOwnerFullname | string or null Name of the ultimate beneficial owner |
| note | string or null Free text note regarding the KYC information |
object or null Custom data for the KYC information |
{- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "authorizedSignatory": true,
- "identityDocumentType": 0,
- "idDocReference": "string",
- "idNumber": "string",
- "fullName": "string",
- "street": "string",
- "houseNo": "string",
- "houseNoExtension": "string",
- "city": "string",
- "stateCode": "string",
- "zipCode": "string",
- "countryCode": "string",
- "residenceCountryCode": "string",
- "pepStatus": 0,
- "ultimateBeneficialOwnerIdNumber": "string",
- "ultimateBeneficialOwnerFullname": "string",
- "note": "string",
- "data": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}| kycEventGuid required | string KYC event guid |
| $filter | string Filter conditions specified in a simplified OData format |
| $skip | integer <int32> List offset when paginating (default 0) |
| $top | integer <int32> Maximum size of result (default 25, max 100) |
| $orderby | string Sorting conditions E.g. "fullname desc" |
{- "count": 0,
- "skip": 0,
- "total": 0,
- "value": [
- {
- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "important": true,
- "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}
]
}| kycEventGuid required | string Loan guid |
Document information
| note required | string non-empty Free extra information related to the document. |
| documentType | string or null Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik). |
| loggedAt | string or null <date-time> Document creation date. |
| originalFileName required | string non-empty The file name to be generated instead of an auto-generated one. |
| searchValue | string or null Document specific search value or reference number. |
| externalLink | string or null Link to the document, if it exists on external archive. |
| important | boolean or null Document importancy flag. |
| fileDataBase64 | string or null Base64-encoded file body. |
{- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "searchValue": "string",
- "externalLink": "string",
- "important": true,
- "fileDataBase64": "string"
}{- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "important": true,
- "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}| kycEventGuid required | string The unique GUID of the KYC event |
| documentGuid required | string The unique GUID of the document |
{- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "important": true,
- "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}Execute custom service definition in CLVR with possibility to pass in JSON into definition.
| guid required | string KYC event guid |
| serviceDefinition required | string The invoke service definition request. |
| async | boolean Specify if custom action should be performed asynchronously |
JSON body
{- "name1": "string",
- "name2": false,
- "name3": {
- "name4": [
- "string",
- "string"
]
}
}{ }Execute custom service definition in CLVR with possibility to pass in JSON into definition.
| serviceDefinition required | string The invoke service definition request. |
| async | boolean Specify if custom action should be performed asynchronously |
JSON body
{- "name1": "string",
- "name2": false,
- "name3": {
- "name4": [
- "string",
- "string"
]
}
}{ }| $filter | string Filter conditions specified in a simplified OData format |
| $skip | integer <int32> List offset when paginating (default 0) |
| $top | integer <int32> Maximum size of result (default 25, max 100) |
| $orderby | string Sorting conditions E.g. "fullname desc" |
{- "count": 0,
- "skip": 0,
- "total": 0,
- "value": [
- {
- "riskGuid": "string",
- "regDate": "2019-08-24T14:15:22Z",
- "userCode": "string",
- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "scoring": "string",
- "minInterestRate": 0.1,
- "note": "string"
}
]
}Risk information
| customerGuid | string or null Guid of the customer the risk information regards |
| clientGuid | string or null Guid of the client the risk information regards |
| debtorGuid | string or null Guid of the debtor the risk information regards |
| manuallyRegistered | boolean True if the risk information was manually registered |
| providerCode | string or null Code for the provider of the risk information |
| provider | string or null Provider of the risk information |
| scoring | string or null Scoring based on the risk information |
| minInterestRate | number or null <double> Minimum interest rate allowed based on the risk information |
| note | string or null Free text note regarding the risk information |
object or null Custom data for the risk information |
{- "customerGuid": "string",
- "clientGuid": "string",
- "debtorGuid": "string",
- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "scoring": "string",
- "minInterestRate": 0.1,
- "note": "string",
- "data": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}| riskGuid required | string Risk guid |
{- "riskGuid": "string",
- "regDate": "2019-08-24T14:15:22Z",
- "userCode": "string",
- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "scoring": "string",
- "minInterestRate": 0.1,
- "note": "string",
- "data": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}, - "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}| riskGuid required | string Risk guid |
Risk information
| manuallyRegistered | boolean True if the risk information was manually registered |
| providerCode | string or null Code for the provider of the risk information |
| provider | string or null Provider of the risk information |
| scoring | string or null Scoring based on the risk information |
| minInterestRate | number or null <double> Minimum interest rate allowed based on the risk information |
| note | string or null Free text note regarding the risk information |
object or null Custom data for the risk information |
{- "manuallyRegistered": true,
- "providerCode": "string",
- "provider": "string",
- "scoring": "string",
- "minInterestRate": 0.1,
- "note": "string",
- "data": {
- "property1": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}, - "property2": {
- "options": {
- "propertyNameCaseInsensitive": true
}, - "parent": { },
- "root": { }
}
}
}{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}| riskGuid required | string Risk guid |
| $filter | string Filter conditions specified in a simplified OData format |
| $skip | integer <int32> List offset when paginating (default 0) |
| $top | integer <int32> Maximum size of result (default 25, max 100) |
| $orderby | string Sorting conditions E.g. "fullname desc" |
{- "count": 0,
- "skip": 0,
- "total": 0,
- "value": [
- {
- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "important": true,
- "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}
]
}| riskGuid required | string Risk guid |
Document information
| note required | string non-empty Free extra information related to the document. |
| documentType | string or null Document code (one of predefined types idoc / invoice / gjeldsbrev / verdict / domforlik). |
| loggedAt | string or null <date-time> Document creation date. |
| originalFileName required | string non-empty The file name to be generated instead of an auto-generated one. |
| searchValue | string or null Document specific search value or reference number. |
| externalLink | string or null Link to the document, if it exists on external archive. |
| important | boolean or null Document importancy flag. |
| fileDataBase64 | string or null Base64-encoded file body. |
{- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "searchValue": "string",
- "externalLink": "string",
- "important": true,
- "fileDataBase64": "string"
}{- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "important": true,
- "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}| riskGuid required | string Risk guid |
| documentGuid required | string The unique GUID of the document |
{- "note": "string",
- "documentType": "string",
- "loggedAt": "2019-08-24T14:15:22Z",
- "originalFileName": "string",
- "important": true,
- "links": [
- {
- "type": "string",
- "name": "string",
- "href": "string",
- "resource": "string",
- "guid": "string"
}
]
}Execute custom service definition in CLVR with possibility to pass in JSON into definition.
| guid required | string Risk guid |
| serviceDefinition required | string The invoke service definition request. |
| async | boolean Specify if custom action should be performed asynchronously |
JSON body
{- "name1": "string",
- "name2": false,
- "name3": {
- "name4": [
- "string",
- "string"
]
}
}{ }Execute custom service definition in CLVR with possibility to pass in JSON into definition.
| serviceDefinition required | string The invoke service definition request. |
| async | boolean Specify if custom action should be performed asynchronously |
JSON body
{- "name1": "string",
- "name2": false,
- "name3": {
- "name4": [
- "string",
- "string"
]
}
}{ }