www.creditsafe.com
Open in
urlscan Pro
2606:4700:10::6816:a84
Public Scan
URL:
https://www.creditsafe.com/gb/en/enterprise/integrations/api-documentation.html
Submission: On December 20 via api from US — Scanned from DE
Submission: On December 20 via api from US — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
* CONTACT SALES & SUPPORT
Contact Sales or Support.
Phone: 02920 886 500
Contact us
* * Creditsafe Group
* Belgium
* Canada
* Denmark
* Deutschland
* France
* Ireland
* Italia
* Japan
* Nederland
* Norge
* Sverige
* United Kingdom
* United States
* English
* English
Credit & Risk
COMPANY CREDIT CHECK
Credit check any company or business with a free company credit report.
Get a free report
Back
CREDIT INFORMATION
--------------------------------------------------------------------------------
* Company Credit Check
* International Credit Check
* Consumer Credit Check
* Open Banking
PAYMENTS & COLLECTIONS
--------------------------------------------------------------------------------
* Bank Account Verification
* Commercial Debt Recovery
* Ledger Management
Compliance
ANTI-MONEY LAUNDERING
Meet money laundering regulations with real-time AML Checks.
Explore our platform
Back
COMPLIANCE SOLUTIONS
--------------------------------------------------------------------------------
* Anti-money laundering
* PEP and Sanction Screening
* Identity & KYC checks
* Know Your Business (KYB)
Sales & Marketing
BUILD GLOBAL MARKETING LISTS
Grow your business with fresh business and contact data for 66 million
companies across 13 countries.
Find out more
Back
DATA MANAGEMENT
--------------------------------------------------------------------------------
* Data Matching & Enrichment
* B2B Data Lists
* Data Licensing
INTEGRATIONS
--------------------------------------------------------------------------------
* Salesforce Integration
API & Integrations
CREDITSAFE API
A single API for global business, compliance, and consumer intelligence.
Explore our API
Back
CONNECT API
--------------------------------------------------------------------------------
* Creditsafe API
* API Documentation
PRE-BUILT INTEGRATIONS
--------------------------------------------------------------------------------
* Salesforce Integration
* Sage 50 App
* CRM Integration
More
Back
OUR COMPANY
--------------------------------------------------------------------------------
* About Creditsafe
* Customer service
* Work for us
RESOURCES
--------------------------------------------------------------------------------
* Content hub
* Customer stories
* Webinars
* Industry Solutions
HELP & SUPPORT
--------------------------------------------------------------------------------
* Contact us
* Help hub
* Contact Sales or Support.
Back
CONTACT SALES & SUPPORT
Contact Sales or Support.
Phone: 02920 886 500
Contact us
* United Kingdom
Back
* Creditsafe Group
* Belgium
* Canada
* Denmark
* Deutschland
* France
* Ireland
* Italia
* Japan
* Nederland
* Norge
* Sverige
* United Kingdom
* United States
* Language
Back
* English
* Free trial
* Login
* Authentication
* postAuthenticate
* getSubscription Details
* Companies
* getCompany Search
* getCompany Credit Report
* getCompany Search Criteria
* getConfidence Match Search
* People/Directors
* getDirector Search
* getDirector Report
* getPeople/Director Search Criteria
* Images
* getCompany Image Documents
* getImage Document Category Types
* getCompany Image
* Fresh Investigations
* postCreate FreshInvestigation
* getGet FreshInvestigations
* getRetrieve FreshInvestigation Order
* getRetrieve FreshInvestigation Report Content
* Global Monitoring
* getMonitoring User Details
* getList Company Events
* getAll EventRules
* getFiltered EventRules
* getAll Notification Events
* getList All Portfolios
* postCreate Monitoring Portfolio
* getRetrieve Portfolio By Id
* delDelete Portfolio
* patchUpdate Portfolio Details
* getList Countries of Monitored Companies
* getList Portfolio EventRules
* getList Portfolio EventRules By Country
* putUpdate EventRules
* putSet Portfolio Default Rules
* getPortfolio Risk Summary
* getList Portfolio Notifications
* patchUpdate isProcessed Flag
* getList Companies In A Portfolio
* postAdd Company To Portfolio
* postCopy Companies Between Portfolios
* postMove Companies Between Portfolios
* patchClear Companies From Portfolio
* getGet Company Details From A Portfolio
* delDelete Company From Portfolio
* patchUpdate Company Details In Portfolio
* getList Company Specific NotificationEvents
* getPortfolio User Permissions
* patchShare Portfolio With Users
* postImport A Portfolio File
* postSync A Portfolio File
* Decision Engine
* getDecision Trees
* getUser Data Fields
* postRun Decision Tree
* getDecision History
* getGet Decision Log
* patchUpdate Decision Log
* Protect
* postCreate Protect Investigation
* getList All Protect Investigations
* getRetrieve Protect Investigation By Id
* getList All Protect Profiles
* postCreate Protect Profile
* getRetrieve Protect Profile By ID
* putEdit Protect Profile
* getList Investigations In A Profile
* putAdd Investigation To Profile
* postCreate Protect Investigation PDF
* getList Matches Per Investigation
* postAdd Match To Investigation
* postCreate Protect Schedule
* getRetrieve Schedule By Id
* delDeletes a Schedule from an Investigation meaning e
* getRetrieve Protect Audit Log
* postExport Audit Log File
* Local Solutions
* getBank Match
* getRetrieves CCDS Data
* GB Consumers and AML
* postSubmits a GB Consumer or AML Search
* putResolves a picklist against a given UniqueId
* getRetrieves a prior identitysearch's input
* getRetrieves a prior identitysearch result.
* getGets identitysearch Reasons.
* getGets a list of identitysearch history items
* putSets the reference for an existing history item
* putRevalidate a given identitysearch with additional documents
* Consumers
* getConsumer Report
* getConsumer Search Criteria
* Misc
* getReport Schema
* getCustom Report Parameters
API docs by Redocly
CREDITSAFE CONNECT (1.5.8)
Download OpenAPI specification:Download
Creditsafe Connect is a REST API that provides access to the Creditsafe Global
Company Database. This allows you to:
* Control your master data
* Utilize up-to-date Business and Director information, enhancing your
onboarding and qualification processes
* Receive alerts when your customer's and supplier's Credit Report changes
CUSTOMER FEEDBACK
Use the buttons below to let us know what you think of this documentation.
Please leave comments in your feedback for the author to consider for future
versions.
Selecting one of the buttons above will open a new tab to the feedback portal.
QUICK START
To start your Creditsafe Connect API integration you will need to have activated
your account and set a password by following the instructions in your Welcome
Email. If you have not received a Welcome Email please contact your Creditsafe
Account Manager.
By default, you will have been setup on our Sandbox environment.
Using a REST API client construct an /authenticate POST request and enter your
username & password (case-sensitive) into the POST body. A successful response
will return an authentication token.
Use the authentication token in an Authorization header on all other Creditsafe
Connect calls as proof of your authenticity.
ENVIRONMENTS
Production Environment baseurl: https://connect.creditsafe.com/v1
Sandbox Test Environment baseurl: https://connect.sandbox.creditsafe.com/v1
RESOURCES
* OpenAPI specification.
* Postman Collection of the most common example calls to Creditsafe Connect.
* A Front End Demo Site. Use this as a quick easy way to validate your username
& password and form requests.
* Help Articles including:
* FAQs
* Data Dictionaries
* Data Availability per Country
* Feature Availability Matrix
AUTHENTICATION
Endpoint to generate a Bearer JWT (Authentication Token). It is mandatory to
include this token under the Header Authorization When calling all other
endpoints as proof of authenticity. Tokens can exist concurrently and persist
for 1 hour from its issued time.
AUTHENTICATE
post/authenticate
https://connect.creditsafe.com/v1/authenticate
https://connect.sandbox.creditsafe.com/v1/authenticate
Supply username and password to generate Authentication Token
REQUEST BODY SCHEMA: APPLICATION/JSON
username
string
password
string
RESPONSES
200
401
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "username": "username@domain.com",
* "password": "^1gHySRA56aj>tf421o"
}
RESPONSE SAMPLES
* 200
* 401
Content type
application/json
Copy
{
* "token":
"eyJhbGciOiJSUzI1NiIsImtpZCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyIsInR5cCI6IkpXVCIsIng1dCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyJ9.eyJuYmYiOjE1OTU0MTYyMDksImV4cCI6MTU5NTQxOTgwOSwiaXNzIjoiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20iLCJhdWQiOlsiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20vcmVzb3VyY2VzIiwiY29ubmVjdF9hcGkiLCJ1Ym9fYXBpX2dhdGV3YXkiXSwiY2xpZW50X2lkIjoiY29ubmVjdC5hcGkuY2xpZW50Iiwic3ViIjoiMTAxNTIwMjg1IiwiYXV0aF90aW1lIjoxNTk1NDE2MjA5LCJpZHAiOiJsb2NhbCIsInVzZXJuYW1lIjoiQ29ubmVjdHUxIiwiZW1haWwiOiJDb25uZWN0MUBnbWFpbC5jb20iLCJjdXN0b21lcklkIjoiMTAxNzY0NDA1IiwiY291bnRyeSI6IkMwIiwidXNlclJvbGUiOiJDcm1BZG1pblBsdXMiLCJzYl9jb3VudHJ5IjoiVVMiLCJzY29wZSI6WyJjb25uZWN0X2FwaSIsInVib19hcGlfZ2F0ZXdheSJdLCJhbXIiOlsicHdkIl19.p8kPAlKNB9iWEKiQbfbRXBoLQuBG7NuEDN__A8AQ55CL-gcIwkS1717Af1f9W0uifwIQ6HAZQR_x191LVkvuWD94Zw8zLzzr1ioUIhQny_zYuAS3G6EFNaTHh_mvOQ9XVi1FyuIy6YYcYcNLNZurFuITF2w5LuX4YQBjQy3rhEAdRoKcUKbtCClMFaH2dV35jiX2d7BqyhtJ8GeZyJ6yfMfdzznqxlJ4Osf5aasKUy8RYKEpjU2pkCURojoy5_oviGs8X4U9mJWcuajmPF3i5DHkqbhq1Mp0UZrDyoq_0BDStV5xqRgq6aOY8mc45kX7cwY3O2hPeGE7Ak8YtKFbA"
}
SUBSCRIPTION DETAILS
get/access
https://connect.creditsafe.com/v1/access
https://connect.sandbox.creditsafe.com/v1/access
Returns the available countries in your subscription - Company Report, Director
Report, Offline Reports and Monitoring.
AUTHORIZATIONS:
bearerToken
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "string",
* "countryAccess": {
* "creditsafeConnectOnlineReports": [
* {
* "countryName": "string",
* "templateName": "string",
* "countryIso2": "string",
* "startDate": "string",
* "expireDate": "string",
* "paid": 0,
* "used": 0
}
],
* "creditsafeConnectOfflineReports": [
* {
* "name": "string",
* "countryIso2": "string",
* "startDate": "string",
* "expireDate": "string",
* "paid": 0,
* "used": 0
}
],
* "creditsafeConnectMonitoring": [
* {
* "name": "string",
* "startDate": "string",
* "expireDate": "string",
* "paid": 0,
* "used": 0
}
],
* "creditsafeConnectDirectorReports": [
* {
* "countryName": "string",
* "countryIso2": "string",
* "startDate": "string",
* "expireDate": "string",
* "paid": 0,
* "used": 0
}
],
* "creditsafeConnectImageDocuments": [
* {
* "name": "string",
* "countryIso2": "string",
* "startDate": "string",
* "expireDate": "string",
* "paid": 0,
* "used": 0
}
],
* "creditsafeConnectBankValidation": [
* {
* "name": "string",
* "startDate": "string",
* "expireDate": "string",
* "paid": 0,
* "used": 0
}
],
* "creditsafeConnectBankVerification": [
* {
* "name": "string",
* "startDate": "string",
* "expireDate": "string",
* "paid": 0,
* "used": 0
}
]
}
}
COMPANIES
Endpoints to search for Companies in the Creditsafe Global Company Database.
Companies are uniquely identified by the connectId - the identifier used to
order a Company Credit Report. The Company Credit Report is a JSON object
comprising of key business and financial data points such as Credit Score &
Limit, Industry Code, Directors, Balance Sheet and Negative Information. A full
list of Company data points can be found in the Data Matrix, in the help
resources.
COMPANY SEARCH
get/companies
https://connect.creditsafe.com/v1/companies
https://connect.sandbox.creditsafe.com/v1/companies
Endpoint to search for Companies according to the provided Search Criteria. To
get the most relevant results, it is recommended to use a unique identifier such
as regNo where available. If a unique identifier is not available, use a
combination of the companies registered postCode and name for the next best hit
rate.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
countries
required
object
Example: countries=GB,FR
comma-separated list of iso-2 country codes.
The code PLC can be used here to search for companies of this type across all
countries.
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
language
string or null = 2 characters
Default: null
Typically only used for Countries where more than one Company Name exists for
different languages e.g. Japanese Kanji and English.
id
string or null
Default: null
connectId - The primary Company identifier that is used to uniquely identify all
companies across Creditsafes Universe and Partner Network. This is returned on
all Company Search Results. Use this field to use in other operations such as
Ordering Company Credit Report by Id, and Adding Company to Monitoring
Portfolio.
safeNo
string or null
Safe Number - Identifier for Companies in Creditsafe's Home Countries.
regNo
string or null
Local Company Identifier - The Company identifier associated with it's Domestic
Filing Agency. i.e. French SIREN/SIRET, United Kingdom Companies House CRN.
vatNo
string or null
Company VAT Number
name
string or null
Company Name
tradeName
string or null
Trade Name of the Company, typically used in Countries where Name is not
uniquely registered.
acronym
string or null
A (non-unique) identifier to look for Companies by their more commonly known
acronym rather than their lesser known full name. Acronym is predominantly
available on French Companies.
exact
boolean or null
Provide as true to find Companies matching a Name exactly.
address
string or null
street
string or null
Default: null
Address part identifier - Street of the Company
houseNo
string or null
Address part identifier - House/Building Number of the Company
city
string or null
Address part identifier - City of the Company
postCode
string or null
Address part identifier - Postcode/Zip Code of the Company. Can be provided
partially to extend to a region with a * as a wildcard. I.e. CF* can represent
all postcodes starting with CF.
province
string or null
Address part identifier - Province/State of the Company
callRef
string or null
Default: null
Call Reference
officeType
string (Creditsafe.GlobalData.OfficeType)
Enum: "Registered" "Trading" "HeadOffice" "Branch" "Subsidiary" "Franchise"
"Franchisor" "SingleOffice"
phoneNo
Array of strings or null
Provides Array of phone numbers or Null
status
string (Creditsafe.GlobalData.CompanyStatus)
Enum: "Active" "NonActive" "Pending" "Other"
type
string (Creditsafe.GlobalData.CompanyType)
Enum: "NotSet" "Ltd" "NonLtd" "NonLtdNonReg"
NonLtdNonReg is only available for countries in Norway.
website
string or null
customData
string or null
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
RESPONSE SAMPLES
* 200
Content type
application/json
Example
Creditsafe.GlobalData.SearchResponse_1_Creditsafe.GlobalData.CompanyConnect.CompanySearch.NoResultsCreditsafe.GlobalData.SearchResponse_1_Creditsafe.GlobalData.Company
Copy
Expand all Collapse all
{
* "correlationId": "string",
* "page": 0,
* "pageSize": 0,
* "totalSize": 0,
* "companies": [
* {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { },
* "dateOfLatestAccounts": "2019-08-24T14:15:22Z",
* "dateOfLatestChange": "2019-08-24T14:15:22Z",
* "activityCode": "string"
}
]
}
COMPANY CREDIT REPORT
get/companies/{connectId}
https://connect.creditsafe.com/v1/companies/{connectId}
https://connect.sandbox.creditsafe.com/v1/companies/{connectId}
Orders a Company Credit Report by connectId.
To acquire a PDF version of the report use the optional request in 'Header'.
This request will provide a 'Base64-encoded' script to convert to a PDF, this
will appear at the end of the JSON response.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
connectId
required
string
Example: GB-0-03836192
The connectId (optionally Safe Number where available) of the Company required
to order their Credit Report. Obtained from /companies search results.
QUERY PARAMETERS
language
string or null^[a-zA-Z]{2}$
Default: "en"
Report Language - The JSON structure of the Report is language invariant, but
field content will return as the given language, where available.
template
string or null
Default: "full"
Optional parameter to request a Templated Company Report. A Template
adds/reduces sections of the Credit Report depending on your subscription. Do
not include this parameter if you have not been given a template to use.
customData
string or null
Additional Report Parameters e.g. German Report Reason Code value is
de_reason_code::1 . Use /reportcustomdata/{country} endpoint to see all values.
callRef
string or null
Default: null
Call Reference
HEADER PARAMETERS
Authorization
required
string
Authorization Token
Accept
string
Example: application/json+pdf
Applies request for PDF link to Company Report.
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/jsonapplication/json+pdfapplication/json
Copy
Expand all Collapse all
{
* "correlationID": "string",
* "failedSections": [
* "CompanySummary"
],
* "report": {
* "companyId": "string",
* "language": "OM",
* "companySummary": {
* "businessName": "string",
* "country": "AF",
* "companyNumber": "string",
* "companyRegistrationNumber": "string",
* "mainActivity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "companyStatus": {
* "status": "Active",
* "description": "string"
},
* "latestTurnoverFigure": {
* "currency": "AFA",
* "value": 0
},
* "latestShareholdersEquityFigure": {
* "currency": "AFA",
* "value": 0
},
* "creditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
}
},
* "companyIdentification": {
* "basicInformation": {
* "businessName": "string",
* "registeredCompanyName": "string",
* "companyRegistrationNumber": "string",
* "country": "AF",
* "vatRegistrationNumber": "string",
* "vatRegistrationDate": "2019-08-24T14:15:22Z",
* "companyRegistrationDate": "2019-08-24T14:15:22Z",
* "operationsStartDate": "2019-08-24T14:15:22Z",
* "commercialCourt": "string",
* "legalForm": {
* "commonCode": "string",
* "providerCode": "string",
* "description": "string"
},
* "ownershipType": "string",
* "companyStatus": {
* "status": "Active",
* "description": "string"
},
* "principalActivity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "contactAddress": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
}
},
* "activityClassifications": [
* {
* "classification": "string",
* "activities": [
* {
* "code": "string",
* "description": "string"
}
]
}
],
* "previousNames": [
* {
* "dateChanged": "2019-08-24T14:15:22Z",
* "name": "string"
}
],
* "previousLegalForms": [
* {
* "dateChanged": "2019-08-24T14:15:22Z",
* "legalForm": {
* "commonCode": "string",
* "providerCode": "string",
* "description": "string"
}
}
]
},
* "creditScore": {
* "currentCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "currentContractLimit": {
* "currency": "AFA",
* "value": 0
},
* "previousCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "latestRatingChangeDate": "2019-08-24T14:15:22Z"
},
* "contactInformation": {
* "mainAddress": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "otherAddresses": [
* {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
}
],
* "previousAddresses": [
* {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
}
],
* "emailAddresses": [
* "string"
],
* "websites": [
* "string"
]
},
* "shareCapitalStructure": {
* "nominalShareCapital": {
* "currency": "AFA",
* "value": 0
},
* "issuedShareCapital": {
* "currency": "AFA",
* "value": 0
},
* "shareCapitalCurrency": "string",
* "numberOfSharesIssued": 0,
* "shareHolders": [
* {
* "id": "string",
* "idType": "Other",
* "name": "string",
* "title": "string",
* "firstNames": "string",
* "firstName": "string",
* "middleName": "string",
* "surname": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "shareholderType": "Other",
* "shareType": "string",
* "currency": "AFA",
* "totalValueOfSharesOwned": 0,
* "totalNumberOfSharesOwned": 0,
* "percentSharesHeld": 0,
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z",
* "hasNegativeInfo": true,
* "shareClasses": [
* {
* "shareType": "string",
* "currency": "AFA",
* "valuePerShare": 0,
* "jointlyOwned": true,
* "numberOfSharesOwned": 0,
* "valueOfSharesOwned": 0,
* "additionalData": { }
}
]
}
]
},
* "directors": {
* "currentDirectors": [
* {
* "id": "string",
* "idType": "Other",
* "name": "string",
* "title": "string",
* "firstNames": "string",
* "firstName": "string",
* "middleName": "string",
* "surname": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "gender": "Unknown",
* "birthName": "string",
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "placeOfBirth": "string",
* "nationality": "string",
* "countryOfResidence": "string",
* "country": "AF",
* "directorType": "Other",
* "hasNegativeInfo": true,
* "signingAuthority": true,
* "positions": [
* {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { }
}
],
* "additionalData": { }
}
],
* "previousDirectors": [
* {
* "id": "string",
* "idType": "Other",
* "name": "string",
* "title": "string",
* "firstNames": "string",
* "firstName": "string",
* "middleName": "string",
* "surname": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "gender": "Unknown",
* "birthName": "string",
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "placeOfBirth": "string",
* "nationality": "string",
* "countryOfResidence": "string",
* "country": "AF",
* "directorType": "Other",
* "hasNegativeInfo": true,
* "signingAuthority": true,
* "positions": [
* {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { }
}
],
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
}
]
},
* "directorships": {
* "currentDirectorships": [
* {
* "id": "string",
* "title": "string",
* "initials": "string",
* "name": "string",
* "position": {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
},
* "registrationNumber": "string",
* "companyName": "string",
* "status": {
* "status": "Active",
* "description": "string"
}
}
],
* "previousDirectorships": [
* {
* "id": "string",
* "title": "string",
* "initials": "string",
* "name": "string",
* "position": {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
},
* "registrationNumber": "string",
* "companyName": "string",
* "status": {
* "status": "Active",
* "description": "string"
}
}
]
},
* "otherInformation": {
* "bankers": [
* {
* "name": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "bankCode": "string",
* "bic": "string"
}
],
* "advisors": [
* {
* "auditorName": "string",
* "solicitorName": "string",
* "accountantName": "string"
}
],
* "employeesInformation": [
* {
* "year": 0,
* "numberOfEmployees": "string"
}
]
},
* "groupStructure": {
* "ultimateParent": {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
},
* "immediateParent": {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
},
* "subsidiaryCompanies": [
* {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
}
],
* "affiliatedCompanies": [
* {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
}
]
},
* "extendedGroupStructure": [
* {
* "id": "string",
* "country": "string",
* "safeNumber": "string",
* "idType": "Other",
* "companyName": "string",
* "registeredNumber": "string",
* "latestAnnualAccounts": "2019-08-24T14:15:22Z",
* "level": 0,
* "percentOfOwnership": 0,
* "status": "string",
* "commonRatingBand": "string",
* "additionalData": { }
}
],
* "financialStatements": [
* {
* "yearEndDate": "2019-08-24T14:15:22Z",
* "numberOfWeeks": 0,
* "currency": "AFA",
* "consolidatedAccounts": true,
* "profitAndLoss": {
* "revenue": 0,
* "operatingCosts": 0,
* "operatingProfit": 0,
* "wagesAndSalaries": 0,
* "pensionCosts": 0,
* "depreciation": 0,
* "amortisation": 0,
* "financialIncome": 0,
* "financialExpenses": 0,
* "extraordinaryIncome": 0,
* "extraordinaryCosts": 0,
* "profitBeforeTax": 0,
* "tax": 0,
* "profitAfterTax": 0,
* "dividends": 0,
* "minorityInterests": 0,
* "otherAppropriations": 0,
* "retainedProfit": 0
},
* "balanceSheet": {
* "landAndBuildings": 0,
* "plantAndMachinery": 0,
* "otherTangibleAssets": 0,
* "totalTangibleAssets": 0,
* "goodwill": 0,
* "otherIntangibleAssets": 0,
* "totalIntangibleAssets": 0,
* "investments": 0,
* "loansToGroup": 0,
* "otherLoans": 0,
* "miscellaneousFixedAssets": 0,
* "totalOtherFixedAssets": 0,
* "totalFixedAssets": 0,
* "rawMaterials": 0,
* "workInProgress": 0,
* "finishedGoods": 0,
* "otherInventories": 0,
* "totalInventories": 0,
* "tradeReceivables": 0,
* "groupReceivables": 0,
* "receivablesDueAfter1Year": 0,
* "miscellaneousReceivables": 0,
* "totalReceivables": 0,
* "cash": 0,
* "otherCurrentAssets": 0,
* "totalCurrentAssets": 0,
* "totalAssets": 0,
* "tradePayables": 0,
* "bankLiabilities": 0,
* "otherLoansOrFinance": 0,
* "groupPayables": 0,
* "miscellaneousLiabilities": 0,
* "totalCurrentLiabilities": 0,
* "tradePayablesDueAfter1Year": 0,
* "bankLiabilitiesDueAfter1Year": 0,
* "otherLoansOrFinanceDueAfter1Year": 0,
* "groupPayablesDueAfter1Year": 0,
* "miscellaneousLiabilitiesDueAfter1Year": 0,
* "totalLongTermLiabilities": 0,
* "totalLiabilities": 0,
* "calledUpShareCapital": 0,
* "sharePremium": 0,
* "revenueReserves": 0,
* "otherReserves": 0,
* "totalShareholdersEquity": 0
},
* "otherFinancials": {
* "contingentLiabilities": "string",
* "workingCapital": 0,
* "netWorth": 0
},
* "ratios": {
* "preTaxProfitMargin": 0,
* "returnOnCapitalEmployed": 0,
* "returnOnTotalAssetsEmployed": 0,
* "returnOnNetAssetsEmployed": 0,
* "salesOrNetWorkingCapital": 0,
* "stockTurnoverRatio": 0,
* "debtorDays": 0,
* "creditorDays": 0,
* "currentRatio": 0,
* "liquidityRatioOrAcidTest": 0,
* "currentDebtRatio": 0,
* "gearing": 0,
* "equityInPercentage": 0,
* "totalDebtRatio": 0
}
}
],
* "localFinancialStatements": [
* {
* "yearEndDate": "2019-08-24T14:15:22Z",
* "numberOfWeeks": 0,
* "currency": "AFA",
* "consolidatedAccounts": true
}
],
* "negativeInformation": { },
* "additionalInformation": { },
* "directorsExtra": { },
* "extendedGroupStructureExtra": { },
* "paymentData": { },
* "paymentDataExtra": { },
* "alternateSummary": { },
* "negativeInformationExtra": { }
},
* "companyID": "string",
* "dateOfOrder": "2019-08-24T14:15:22Z",
* "language": "string",
* "userID": 0
}
COMPANY SEARCH CRITERIA
get/companies/searchcriteria
https://connect.creditsafe.com/v1/companies/searchcriteria
https://connect.sandbox.creditsafe.com/v1/companies/searchcriteria
Returns the set of available Company Search parameters/fields for a provided
list of countries.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
countries
string
A comma separated list of ISO/Alpha 2 format country codes, or singular country
Code. e.g. US,GB will return the common searchable Company fields in the United
States and Great Britain.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "correlationId": "string",
* "countries": [
* "AF"
],
* "languages": [
* "string"
],
* "criteriaSets": [
* {
* "id": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "safeNo": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "regNo": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "vatNo": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "name": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string",
* "allowedMatchTypes": [
* "MatchBeginning"
]
},
* "type": {
* "optional": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "NotSet"
],
* "validationRegExp": "string"
},
* "officeType": {
* "optional": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "Registered"
],
* "validationRegExp": "string"
},
* "status": {
* "optional": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "Active"
],
* "validationRegExp": "string"
},
* "address": {
* "simpleValue": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string",
* "allowedMatchTypes": [
* "MatchBeginning"
]
},
* "street": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "houseNo": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "city": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "postCode": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "province": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
}
},
* "phoneNumber": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "website": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "includeTradingNames": {
* "optional": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* true
],
* "validationRegExp": "string"
},
* "includeTradingAddresses": {
* "optional": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* true
],
* "validationRegExp": "string"
}
}
]
}
]
CONFIDENCE MATCH SEARCH
get/companies/match
https://connect.creditsafe.com/v1/companies/match
https://connect.sandbox.creditsafe.com/v1/companies/match
Supply all company search criteria to find potential company matches ranked by a
single score. - See here for more information
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
country
required
string
Example: country=GB
Iso-2 country code
matchThreshold
integer
Example: matchThreshold=905
Return matches above this score (900 - 999)
regNo
string or null
Local Company Identifier - The Company identifier associated with it's Domestic
Filing Agency. i.e. French SIREN/SIRET, United Kingdom Companies House CRN.
vatNo
string or null
Company VAT Number
name
string or null
Company Name
street
string or null
Default: null
Address part identifier - Street of the Company
houseNo
string or null
Address part identifier - House/Building Number of the Company
city
string or null
Address part identifier - City of the Company
postCode
string or null
Address part identifier - Postcode/Zip Code of the Company.
province
string or null
Address part identifier - Province of the Company
state
string or null
Address part identifier - State of the Company
phoneNo
string or null
reference1
string
Example: reference1=free text 1
Customer supplied free text reference 1 of 3
reference2
string
Example: reference2=free text 2
Customer supplied free text reference 2 of 3
reference3
string
Example: reference3=free text 3
Customer supplied free text reference 3 of 3
callRef
string or null
Default: null
Call Reference
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Example
Connect.ConfidenceMatch.MatchResultsConnect.ConfidenceMatch.NoResultsConnect.ConfidenceMatch.MatchResults
Copy
Expand all Collapse all
{
* "totalMatches": 0,
* "matchedCompanies": [
* {
* "matchScoreConfidence": 0,
* "id": "string",
* "country": "string",
* "regNo": "string",
* "safeNo": "string",
* "name": "string",
* "phoneNumber": 0,
* "address": {
* "simpleValue": "string",
* "street": "string",
* "city": "string",
* "postcode": "string",
* "country": "string",
* "state": "string"
},
* "status": "string",
* "type": "string",
* "officeType": "string",
* "dateOfLatestAccounts": "string",
* "dateOfLatestChange": "string",
* "matchScoreExplainPlan": {
* "matchScore": 0,
* "matchScoreAlpha": "string",
* "matchScoreLocal Id": "string",
* "matchScoreName": "string",
* "matchScoreHouseNo": "string",
* "matchScoreStreet": "string",
* "matchScorePoBox": "string",
* "matchScoreCity": "string",
* "matchScoreState": "string",
* "matchScorePostCode": "string",
* "matchScoreCountry": "string",
* "matchScoreVatNo": "string",
* "matchScoreRegNo": "string",
* "matchScorePhoneNo": "string",
* "matchScoreSimpleValue": "string",
* "matchScoreNum": "string"
}
}
]
}
PEOPLE/DIRECTORS
Endpoints to find People/Directors and order Director Reports. A Director Report
will contain a person's registered information and Active & Previous
Directorships, where available. This endpoint is not advised to get a list of
directors for a specific Company. Instead, order a Company Credit Report using
the /companies/{id} endpoint, and use the directors section in the response.
DIRECTOR SEARCH
get/people
https://connect.creditsafe.com/v1/people
https://connect.sandbox.creditsafe.com/v1/people
Endpoint to find Directors based on search criteria to order a Creditsafe
Director Report.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
countries
required
object
Example: countries=GB,FR
comma-separated list of iso-2 country codes
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
peopleId
string
Person/Director Identifier - used to order a Director Report.
firstName
string
Person's First Name.
lastName
string
Person's Last Name
localDirectorNumber
string or null
Local Identifier of the Director, the PNR in GB.
dateOfBirth
string
Person DOB - provide YYYY-MM-DD or YYYY-MM format.
callRef
string or null
Call Reference
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "chargeReference": "string",
* "messages": [
* {
* "type": "Information",
* "code": "NoResults",
* "text": "string"
}
],
* "directors": [
* {
* "country": "AF",
* "peopleId": "string",
* "dateOfLatestChange": "2019-08-24T14:15:22Z",
* "firstName": "string",
* "lastName": "string",
* "companyId": "string",
* "companyName": "string",
* "companyType": "NotSet",
* "companyRegistrationNumber": "string",
* "status": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "searchRanking": "string"
}
],
* "page": 0,
* "pageSize": 0,
* "totalSize": 0
}
DIRECTOR REPORT
get/people/{peopleId}
https://connect.creditsafe.com/v1/people/{peopleId}
https://connect.sandbox.creditsafe.com/v1/people/{peopleId}
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
peopleId
required
string^[a-zA-Z]{2}([0-9]{1,3})?[-]{1}[a-zA-Z0-9$]+$...
Identifier of the Person/Director required to order their Director Report.
Obtained from /people search results.
QUERY PARAMETERS
language
string^[a-zA-Z]{2}$
Default: "en"
Report Language - The JSON structure of the Report is language invariant, but
field content will return as the given language, where available.
callRef
string
Call Reference
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "chargeReference": "string",
* "messages": [
* {
* "type": "Information",
* "code": "NoResults",
* "text": "string"
}
],
* "report": {
* "directorId": "string",
* "directorSummary": {
* "currentAppointments": 0,
* "inactiveAppointments": 0,
* "previousAppointments": 0
},
* "directorDetails": {
* "id": "string",
* "idType": "Other",
* "name": "string",
* "title": "string",
* "firstNames": "string",
* "firstName": "string",
* "middleName": "string",
* "surname": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "gender": "Unknown",
* "birthName": "string",
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "placeOfBirth": "string",
* "nationality": "string",
* "countryOfResidence": "string",
* "country": "AF",
* "directorType": "Other",
* "hasNegativeInfo": true,
* "signingAuthority": true,
* "positions": [
* {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { }
}
],
* "additionalData": { }
},
* "otherAddresses": [
* {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
}
],
* "directorships": {
* "current": [
* {
* "id": "string",
* "idType": "Other",
* "companyName": "string",
* "companyNumber": "string",
* "companyRegistrationNumber": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "status": "Active",
* "activity": {
* "code": "string",
* "description": "string"
},
* "position": {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
},
* "signingAuthority": true,
* "companyRegistrationDate": "2019-08-24T14:15:22Z",
* "legalForm": {
* "commonCode": "string",
* "providerCode": "string",
* "description": "string"
},
* "state": "string",
* "yearEndDate": "2019-08-24T14:15:22Z",
* "currency": "AFA",
* "latestTurnoverFigure": {
* "currency": "AFA",
* "value": 0
},
* "netWorth": {
* "currency": "AFA",
* "value": 0
},
* "legalCount": 0,
* "legalAmount": {
* "currency": "AFA",
* "value": 0
},
* "legalCountInLast12Months": 0,
* "creditScore": {
* "currentCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "currentContractLimit": {
* "currency": "AFA",
* "value": 0
},
* "previousCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "latestRatingChangeDate": "2019-08-24T14:15:22Z"
},
* "dbt": 0,
* "additionalData": { }
}
],
* "previous": [
* {
* "id": "string",
* "idType": "Other",
* "companyName": "string",
* "companyNumber": "string",
* "companyRegistrationNumber": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "status": "Active",
* "activity": {
* "code": "string",
* "description": "string"
},
* "position": {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
},
* "signingAuthority": true,
* "companyRegistrationDate": "2019-08-24T14:15:22Z",
* "legalForm": {
* "commonCode": "string",
* "providerCode": "string",
* "description": "string"
},
* "state": "string",
* "yearEndDate": "2019-08-24T14:15:22Z",
* "currency": "AFA",
* "latestTurnoverFigure": {
* "currency": "AFA",
* "value": 0
},
* "netWorth": {
* "currency": "AFA",
* "value": 0
},
* "legalCount": 0,
* "legalAmount": {
* "currency": "AFA",
* "value": 0
},
* "legalCountInLast12Months": 0,
* "creditScore": {
* "currentCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "currentContractLimit": {
* "currency": "AFA",
* "value": 0
},
* "previousCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "latestRatingChangeDate": "2019-08-24T14:15:22Z"
},
* "dbt": 0,
* "additionalData": { }
}
],
* "inactive": [
* {
* "id": "string",
* "idType": "Other",
* "companyName": "string",
* "companyNumber": "string",
* "companyRegistrationNumber": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "status": "Active",
* "activity": {
* "code": "string",
* "description": "string"
},
* "position": {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
},
* "signingAuthority": true,
* "companyRegistrationDate": "2019-08-24T14:15:22Z",
* "legalForm": {
* "commonCode": "string",
* "providerCode": "string",
* "description": "string"
},
* "state": "string",
* "yearEndDate": "2019-08-24T14:15:22Z",
* "currency": "AFA",
* "latestTurnoverFigure": {
* "currency": "AFA",
* "value": 0
},
* "netWorth": {
* "currency": "AFA",
* "value": 0
},
* "legalCount": 0,
* "legalAmount": {
* "currency": "AFA",
* "value": 0
},
* "legalCountInLast12Months": 0,
* "creditScore": {
* "currentCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "currentContractLimit": {
* "currency": "AFA",
* "value": 0
},
* "previousCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "latestRatingChangeDate": "2019-08-24T14:15:22Z"
},
* "dbt": 0,
* "additionalData": { }
}
]
}
}
}
PEOPLE/DIRECTOR SEARCH CRITERIA
get/people/searchcriteria
https://connect.creditsafe.com/v1/people/searchcriteria
https://connect.sandbox.creditsafe.com/v1/people/searchcriteria
Returns the set of available People Search parameters/fields for a provided list
of countries.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
countries
string
A comma separated list of ISO/Alpha 2 format country codes, or singular country
Code. e.g. US,GB will return the common searchable People/Director fields in the
United States and Great Britain.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "chargeReference": "string",
* "messages": [
* {
* "type": "Information",
* "code": "NoResults",
* "text": "string"
}
],
* "countriesCriteria": [
* {
* "country": "AF",
* "schemas": [
* {
* "id": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "firstName": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string",
* "allowedMatchTypes": [
* "MatchBeginning"
]
},
* "lastName": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string",
* "allowedMatchTypes": [
* "MatchBeginning"
]
},
* "companyId": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "companyName": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string",
* "allowedMatchTypes": [
* "MatchBeginning"
]
},
* "companyType": {
* "optional": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "NotSet"
],
* "validationRegExp": "string"
},
* "companyRegistrationNumber": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "address": {
* "simpleValue": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string",
* "allowedMatchTypes": [
* "MatchBeginning"
]
},
* "street": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "houseNo": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "city": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "postCode": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
},
* "province": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
}
},
* "status": {
* "required": true,
* "minLength": 0,
* "maxLength": 0,
* "allowedValues": [
* "string"
],
* "validationRegExp": "string"
}
}
]
}
],
* "customData": [
* {
* "key": "string",
* "optional": true,
* "allowedValues": [
* "string"
],
* "description": "string"
}
]
}
IMAGES
Endpoints to order official Company Image/Filing Documents from source. Company
Filings such as Annual Account Statements, Annual Returns, Liquidations and
Changes of Registered Information can be downloaded as PDFs, and are typically
used as a resource in extended company auditing/compliance.
COMPANY IMAGE DOCUMENTS
get/images/companies
https://connect.creditsafe.com/v1/images/companies
https://connect.sandbox.creditsafe.com/v1/images/companies
Returns the available Images for a given Company connectId.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
Id
string
The company's connectId.
olderThan
string
Returns Images older than this date. Use with newerThan parameter.
newerThan
string
Returns Images newer than this date. Use with olderThan parameter.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "totalSize": 0,
* "data": [
* {
* "imageId": "string",
* "company": {
* "id": "string",
* "country": "string",
* "localId": "string",
* "name": "string"
},
* "document": {
* "imageType": "string",
* "imageCode": "string",
* "description": "string"
},
* "format": "string",
* "source": "string",
* "filingDate": "string",
* "uploadDate": "string",
* "accountingDate": "string",
* "language": "string",
* "comments": "string",
* "status": "string",
* "localProperties": {
* "accountRefNumber": "string"
}
}
]
}
IMAGE DOCUMENT CATEGORY TYPES
get/images/companies/types
https://connect.creditsafe.com/v1/images/companies/types
https://connect.sandbox.creditsafe.com/v1/images/companies/types
Lists available Image Document formats, types and languages per country.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
countries
string
Filter Images by country.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "country": "string",
* "companyId": {
* "required": true,
* "validationRegExp": "string",
* "minLength": 0,
* "maxLength": 0
},
* "imageReference": {
* "required": true,
* "validationRegExp": "string",
* "minLength": 0,
* "maxLength": 0
},
* "availableLanguages": [
* {
* "language": "string",
* "filingTypes": [
* {
* "type": "string",
* "description": "string",
* "availableImageFormats": [
* "string"
]
}
],
* "default": true
}
]
}
]
COMPANY IMAGE
get/images/{imageId}
https://connect.creditsafe.com/v1/images/{imageId}
https://connect.sandbox.creditsafe.com/v1/images/{imageId}
Endpoint to order an Image Document by Image ID.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
imageId
required
string
Image ID retrieved from images/companies
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
Image object as a binary stream.
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationID": "string",
* "failedSections": [
* "CompanySummary"
],
* "report": {
* "companyId": "string",
* "language": "OM",
* "companySummary": {
* "businessName": "string",
* "country": "AF",
* "companyNumber": "string",
* "companyRegistrationNumber": "string",
* "mainActivity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "companyStatus": {
* "status": "Active",
* "description": "string"
},
* "latestTurnoverFigure": {
* "currency": "AFA",
* "value": 0
},
* "latestShareholdersEquityFigure": {
* "currency": "AFA",
* "value": 0
},
* "creditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
}
},
* "companyIdentification": {
* "basicInformation": {
* "businessName": "string",
* "registeredCompanyName": "string",
* "companyRegistrationNumber": "string",
* "country": "AF",
* "vatRegistrationNumber": "string",
* "vatRegistrationDate": "2019-08-24T14:15:22Z",
* "companyRegistrationDate": "2019-08-24T14:15:22Z",
* "operationsStartDate": "2019-08-24T14:15:22Z",
* "commercialCourt": "string",
* "legalForm": {
* "commonCode": "string",
* "providerCode": "string",
* "description": "string"
},
* "ownershipType": "string",
* "companyStatus": {
* "status": "Active",
* "description": "string"
},
* "principalActivity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "contactAddress": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
}
},
* "activityClassifications": [
* {
* "classification": "string",
* "activities": [
* {
* "code": "string",
* "description": "string"
}
]
}
],
* "previousNames": [
* {
* "dateChanged": "2019-08-24T14:15:22Z",
* "name": "string"
}
],
* "previousLegalForms": [
* {
* "dateChanged": "2019-08-24T14:15:22Z",
* "legalForm": {
* "commonCode": "string",
* "providerCode": "string",
* "description": "string"
}
}
]
},
* "creditScore": {
* "currentCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "currentContractLimit": {
* "currency": "AFA",
* "value": 0
},
* "previousCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "latestRatingChangeDate": "2019-08-24T14:15:22Z"
},
* "contactInformation": {
* "mainAddress": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "otherAddresses": [
* {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
}
],
* "previousAddresses": [
* {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
}
],
* "emailAddresses": [
* "string"
],
* "websites": [
* "string"
]
},
* "shareCapitalStructure": {
* "nominalShareCapital": {
* "currency": "AFA",
* "value": 0
},
* "issuedShareCapital": {
* "currency": "AFA",
* "value": 0
},
* "shareCapitalCurrency": "string",
* "numberOfSharesIssued": 0,
* "shareHolders": [
* {
* "id": "string",
* "idType": "Other",
* "name": "string",
* "title": "string",
* "firstNames": "string",
* "firstName": "string",
* "middleName": "string",
* "surname": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "shareholderType": "Other",
* "shareType": "string",
* "currency": "AFA",
* "totalValueOfSharesOwned": 0,
* "totalNumberOfSharesOwned": 0,
* "percentSharesHeld": 0,
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z",
* "hasNegativeInfo": true,
* "shareClasses": [
* {
* "shareType": "string",
* "currency": "AFA",
* "valuePerShare": 0,
* "jointlyOwned": true,
* "numberOfSharesOwned": 0,
* "valueOfSharesOwned": 0,
* "additionalData": { }
}
]
}
]
},
* "directors": {
* "currentDirectors": [
* {
* "id": "string",
* "idType": "Other",
* "name": "string",
* "title": "string",
* "firstNames": "string",
* "firstName": "string",
* "middleName": "string",
* "surname": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "gender": "Unknown",
* "birthName": "string",
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "placeOfBirth": "string",
* "nationality": "string",
* "countryOfResidence": "string",
* "country": "AF",
* "directorType": "Other",
* "hasNegativeInfo": true,
* "signingAuthority": true,
* "positions": [
* {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { }
}
],
* "additionalData": { }
}
],
* "previousDirectors": [
* {
* "id": "string",
* "idType": "Other",
* "name": "string",
* "title": "string",
* "firstNames": "string",
* "firstName": "string",
* "middleName": "string",
* "surname": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "gender": "Unknown",
* "birthName": "string",
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "placeOfBirth": "string",
* "nationality": "string",
* "countryOfResidence": "string",
* "country": "AF",
* "directorType": "Other",
* "hasNegativeInfo": true,
* "signingAuthority": true,
* "positions": [
* {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { }
}
],
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
}
]
},
* "directorships": {
* "currentDirectorships": [
* {
* "id": "string",
* "title": "string",
* "initials": "string",
* "name": "string",
* "position": {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
},
* "registrationNumber": "string",
* "companyName": "string",
* "status": {
* "status": "Active",
* "description": "string"
}
}
],
* "previousDirectorships": [
* {
* "id": "string",
* "title": "string",
* "initials": "string",
* "name": "string",
* "position": {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
},
* "registrationNumber": "string",
* "companyName": "string",
* "status": {
* "status": "Active",
* "description": "string"
}
}
]
},
* "otherInformation": {
* "bankers": [
* {
* "name": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "bankCode": "string",
* "bic": "string"
}
],
* "advisors": [
* {
* "auditorName": "string",
* "solicitorName": "string",
* "accountantName": "string"
}
],
* "employeesInformation": [
* {
* "year": 0,
* "numberOfEmployees": "string"
}
]
},
* "groupStructure": {
* "ultimateParent": {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
},
* "immediateParent": {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
},
* "subsidiaryCompanies": [
* {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
}
],
* "affiliatedCompanies": [
* {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
}
]
},
* "extendedGroupStructure": [
* {
* "id": "string",
* "country": "string",
* "safeNumber": "string",
* "idType": "Other",
* "companyName": "string",
* "registeredNumber": "string",
* "latestAnnualAccounts": "2019-08-24T14:15:22Z",
* "level": 0,
* "percentOfOwnership": 0,
* "status": "string",
* "commonRatingBand": "string",
* "additionalData": { }
}
],
* "financialStatements": [
* {
* "yearEndDate": "2019-08-24T14:15:22Z",
* "numberOfWeeks": 0,
* "currency": "AFA",
* "consolidatedAccounts": true,
* "profitAndLoss": {
* "revenue": 0,
* "operatingCosts": 0,
* "operatingProfit": 0,
* "wagesAndSalaries": 0,
* "pensionCosts": 0,
* "depreciation": 0,
* "amortisation": 0,
* "financialIncome": 0,
* "financialExpenses": 0,
* "extraordinaryIncome": 0,
* "extraordinaryCosts": 0,
* "profitBeforeTax": 0,
* "tax": 0,
* "profitAfterTax": 0,
* "dividends": 0,
* "minorityInterests": 0,
* "otherAppropriations": 0,
* "retainedProfit": 0
},
* "balanceSheet": {
* "landAndBuildings": 0,
* "plantAndMachinery": 0,
* "otherTangibleAssets": 0,
* "totalTangibleAssets": 0,
* "goodwill": 0,
* "otherIntangibleAssets": 0,
* "totalIntangibleAssets": 0,
* "investments": 0,
* "loansToGroup": 0,
* "otherLoans": 0,
* "miscellaneousFixedAssets": 0,
* "totalOtherFixedAssets": 0,
* "totalFixedAssets": 0,
* "rawMaterials": 0,
* "workInProgress": 0,
* "finishedGoods": 0,
* "otherInventories": 0,
* "totalInventories": 0,
* "tradeReceivables": 0,
* "groupReceivables": 0,
* "receivablesDueAfter1Year": 0,
* "miscellaneousReceivables": 0,
* "totalReceivables": 0,
* "cash": 0,
* "otherCurrentAssets": 0,
* "totalCurrentAssets": 0,
* "totalAssets": 0,
* "tradePayables": 0,
* "bankLiabilities": 0,
* "otherLoansOrFinance": 0,
* "groupPayables": 0,
* "miscellaneousLiabilities": 0,
* "totalCurrentLiabilities": 0,
* "tradePayablesDueAfter1Year": 0,
* "bankLiabilitiesDueAfter1Year": 0,
* "otherLoansOrFinanceDueAfter1Year": 0,
* "groupPayablesDueAfter1Year": 0,
* "miscellaneousLiabilitiesDueAfter1Year": 0,
* "totalLongTermLiabilities": 0,
* "totalLiabilities": 0,
* "calledUpShareCapital": 0,
* "sharePremium": 0,
* "revenueReserves": 0,
* "otherReserves": 0,
* "totalShareholdersEquity": 0
},
* "otherFinancials": {
* "contingentLiabilities": "string",
* "workingCapital": 0,
* "netWorth": 0
},
* "ratios": {
* "preTaxProfitMargin": 0,
* "returnOnCapitalEmployed": 0,
* "returnOnTotalAssetsEmployed": 0,
* "returnOnNetAssetsEmployed": 0,
* "salesOrNetWorkingCapital": 0,
* "stockTurnoverRatio": 0,
* "debtorDays": 0,
* "creditorDays": 0,
* "currentRatio": 0,
* "liquidityRatioOrAcidTest": 0,
* "currentDebtRatio": 0,
* "gearing": 0,
* "equityInPercentage": 0,
* "totalDebtRatio": 0
}
}
],
* "localFinancialStatements": [
* {
* "yearEndDate": "2019-08-24T14:15:22Z",
* "numberOfWeeks": 0,
* "currency": "AFA",
* "consolidatedAccounts": true
}
],
* "negativeInformation": { },
* "additionalInformation": { },
* "directorsExtra": { },
* "extendedGroupStructureExtra": { },
* "paymentData": { },
* "paymentDataExtra": { },
* "alternateSummary": { },
* "negativeInformationExtra": { }
},
* "pdfReportStream": "string",
* "companyID": "string",
* "dateOfOrder": "2019-08-24T14:15:22Z",
* "language": "string",
* "userID": 0
}
FRESH INVESTIGATIONS
Endpoints to manage Fresh Investigation requests. With the need for accurate
data, you can check on any company that is not available within our instant
online database by placing a Fresh Investigation (Offline Order). Depending on
the market, the information we obtain will vary. Using official sources and
registries we are able to quickly answer questions about a company's stability
and financial health. Where official information is not available we will
conduct a direct interview with the business.
CREATE FRESHINVESTIGATION
post/freshinvestigations
https://connect.creditsafe.com/v1/freshinvestigations
https://connect.sandbox.creditsafe.com/v1/freshinvestigations
Places an order for a Fresh Investigation (Offline Report). Providing as much
detail as possible about the Company, our team will use official sources and
registries to quickly answer questions about a company's stability and financial
health. Fresh Investigations take 5.5 days on average to complete. By adding
consent:true to the request, you are allowing Creditsafe to disclose your
company details to the company you have requested the Investigation against, to
be used only in the aim of improving our Investigation report.
AUTHORIZATIONS:
bearerToken
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
consent
boolean
Including this allows Creditsafe to disclose your company details to the target
company in the aim of improving the quality of our Investigation Report
contactInfo
object
Your contact information
chargeReference
string
Free text field to add your own personal reference to the order
searchCriteria
object
Details on the company you are investigating - the target company
RESPONSES
200
400
401
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "consent": true,
* "contactInfo": {
* "name": "string",
* "emailAddress": "string",
* "telephoneNumber": "string",
* "company": {
* "name": "string",
* "number": "string"
}
},
* "chargeReference": "string",
* "searchCriteria": {
* "name": "string",
* "additionalInfo": "string",
* "telephoneNumber": "string",
* "address": {
* "simple": "string",
* "postcode": "string",
* "city": "string"
},
* "regNo": "string",
* "vatNo": "string",
* "countryCode": "string"
}
}
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
{
* "correlationId": "string",
* "message": "string",
* "orderID": "string",
* "transactionID": "string"
}
GET FRESHINVESTIGATIONS
get/freshinvestigations
https://connect.creditsafe.com/v1/freshinvestigations
https://connect.sandbox.creditsafe.com/v1/freshinvestigations
Returns a list of your submitted Fresh Investigation Orders.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
transactionId
string
Fresh Investigation Identifier used internally and with our data partners.
reportCreatedAfter
string
Example: reportCreatedAfter=2020-01-01T11:23:56Z
Returns Fresh Investigations processed after this date
reportCreatedBefore
string
Example: reportCreatedBefore=2020-01-01T11:23:56Z
Returns ordered Fresh Investigations that were processed before this date
createdBefore
string
Returns Fresh Investigations created before this date
createdSince
string
Returns ordered Fresh Investigations created after this date
lookUpOrderBy
string
Enum: "CompanyDetails" "SearchCriteria"
Use to search for your Fresh Investigations by either the returned Company
Details in the GET freshInvestigations/{orderId} endpoint or your supplied
Search Criteria in the POST /freshInvestigations endpoint
companyDetailsCountry
string
Looks for your returned Fresh Investigations where the returned Company Country
is named this. Use with lookUpOrderBy=CompanyDetails
companyDetailsName
string
Looks for your returned Fresh Investigations where the returned Company Name is
named this. Use with lookUpOrderBy=CompanyDetails
searchCriteriaCountry
string
Looks for your returned Fresh Investigations where your submitted Search
Criteria Company Country is this. Use with lookUpOrderBy=searchCriteria
searchCriteriaName
string
Looks for your Fresh Investigations where your submitted Search Criteria Company
Name is this. Use with lookUpOrderBy=searchCriteria
sortBy
string
Enum: "creationDate" "lastStatusChangeDate" "orderID" "status"
Sorts returned Fresh Investigations by this field
sortDir
string
Default: "asc"
Enum: "asc" "desc"
The direction that you wish to sort results by.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "totalCount": 0,
* "orders": [
* {
* "orderID": 0,
* "userID": "string",
* "creationDate": "string",
* "lastStatusChangeDate": "string",
* "transactionID": 0,
* "chargeReference": "string",
* "contactDetails": {
* "name": "string",
* "emailAddress": "string",
* "telephoneNumber": "string"
},
* "sectionNames": "string",
* "status": {
* "code": "string",
* "description": "string"
},
* "consent": true,
* "searchCriteria": {
* "name": "string",
* "vatNo": "string",
* "regNo": "string",
* "additionalInfo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
}
},
* "reportDate": "2019-08-24T14:15:22Z"
}
]
}
RETRIEVE FRESHINVESTIGATION ORDER
get/freshinvestigations/{orderId}
https://connect.creditsafe.com/v1/freshinvestigations/{orderId}
https://connect.sandbox.creditsafe.com/v1/freshinvestigations/{orderId}
Returns a specific Fresh Investigation order.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
orderId
required
string
QUERY PARAMETERS
sections
string
Example: sections=companyIdentification,creditScore
Specify a value to return a single section, or multiple-comma separated sections
of the completed Fresh Investigation. Leave null to return all sections.
Available sections; - companyIdentification - creditScore - contactInformation -
directors - otherInformation - groupStructure - extendedGroupStructure -
financialStatements - negativeInformation - additionalInformation -
directorships - localFinancialStatements - paymentData - companySummary -
alternateSummary
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
Returns a specific Fresh Investigation Order. For completed orders this will
contain the Investigation content as Report Sections.
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "chargeReference": "string",
* "contactDetails": {
* "emailAddress": "string",
* "name": "string",
* "telephoneNumber": "string"
},
* "creationDate": "string",
* "lastStatusChangeDate": "string",
* "orderID": 0,
* "reportDate": "string",
* "searchCriteria": {
* "additionalInfo": "string",
* "address": {
* "city": "string",
* "postcode": "string",
* "simple": "string"
},
* "countryCode": "string",
* "name": "string",
* "regNo": "string",
* "vatNo": "string"
},
* "sections": [
* {
* "content": "string",
* "contentType": "string",
* "creationDate": "string",
* "name": "string"
}
],
* "status": {
* "code": "string",
* "description": "string"
},
* "transactionID": 0
}
RETRIEVE FRESHINVESTIGATION REPORT CONTENT
get/freshinvestigations/{orderId}/report
https://connect.creditsafe.com/v1/freshinvestigations/{orderId}/report
https://connect.sandbox.creditsafe.com/v1/freshinvestigations/{orderId}/report
Returns the Fresh Investigation Report data for a specific order, after the
order has a status of delivered.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
orderId
required
string
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
Investigation Report.
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationID": "string",
* "failedSections": [
* "CompanySummary"
],
* "report": {
* "companyId": "string",
* "language": "OM",
* "companySummary": {
* "businessName": "string",
* "country": "AF",
* "companyNumber": "string",
* "companyRegistrationNumber": "string",
* "mainActivity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "companyStatus": {
* "status": "Active",
* "description": "string"
},
* "latestTurnoverFigure": {
* "currency": "AFA",
* "value": 0
},
* "latestShareholdersEquityFigure": {
* "currency": "AFA",
* "value": 0
},
* "creditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
}
},
* "companyIdentification": {
* "basicInformation": {
* "businessName": "string",
* "registeredCompanyName": "string",
* "companyRegistrationNumber": "string",
* "country": "AF",
* "vatRegistrationNumber": "string",
* "vatRegistrationDate": "2019-08-24T14:15:22Z",
* "companyRegistrationDate": "2019-08-24T14:15:22Z",
* "operationsStartDate": "2019-08-24T14:15:22Z",
* "commercialCourt": "string",
* "legalForm": {
* "commonCode": "string",
* "providerCode": "string",
* "description": "string"
},
* "ownershipType": "string",
* "companyStatus": {
* "status": "Active",
* "description": "string"
},
* "principalActivity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "contactAddress": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
}
},
* "activityClassifications": [
* {
* "classification": "string",
* "activities": [
* {
* "code": "string",
* "description": "string"
}
]
}
],
* "previousNames": [
* {
* "dateChanged": "2019-08-24T14:15:22Z",
* "name": "string"
}
],
* "previousLegalForms": [
* {
* "dateChanged": "2019-08-24T14:15:22Z",
* "legalForm": {
* "commonCode": "string",
* "providerCode": "string",
* "description": "string"
}
}
]
},
* "creditScore": {
* "currentCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "currentContractLimit": {
* "currency": "AFA",
* "value": 0
},
* "previousCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "latestRatingChangeDate": "2019-08-24T14:15:22Z"
},
* "contactInformation": {
* "mainAddress": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "otherAddresses": [
* {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
}
],
* "previousAddresses": [
* {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
}
],
* "emailAddresses": [
* "string"
],
* "websites": [
* "string"
]
},
* "shareCapitalStructure": {
* "nominalShareCapital": {
* "currency": "AFA",
* "value": 0
},
* "issuedShareCapital": {
* "currency": "AFA",
* "value": 0
},
* "shareCapitalCurrency": "string",
* "numberOfSharesIssued": 0,
* "shareHolders": [
* {
* "id": "string",
* "idType": "Other",
* "name": "string",
* "title": "string",
* "firstNames": "string",
* "firstName": "string",
* "middleName": "string",
* "surname": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "shareholderType": "Other",
* "shareType": "string",
* "currency": "AFA",
* "totalValueOfSharesOwned": 0,
* "totalNumberOfSharesOwned": 0,
* "percentSharesHeld": 0,
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z",
* "hasNegativeInfo": true,
* "shareClasses": [
* {
* "shareType": "string",
* "currency": "AFA",
* "valuePerShare": 0,
* "jointlyOwned": true,
* "numberOfSharesOwned": 0,
* "valueOfSharesOwned": 0,
* "additionalData": { }
}
]
}
]
},
* "directors": {
* "currentDirectors": [
* {
* "id": "string",
* "idType": "Other",
* "name": "string",
* "title": "string",
* "firstNames": "string",
* "firstName": "string",
* "middleName": "string",
* "surname": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "gender": "Unknown",
* "birthName": "string",
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "placeOfBirth": "string",
* "nationality": "string",
* "countryOfResidence": "string",
* "country": "AF",
* "directorType": "Other",
* "hasNegativeInfo": true,
* "signingAuthority": true,
* "positions": [
* {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { }
}
],
* "additionalData": { }
}
],
* "previousDirectors": [
* {
* "id": "string",
* "idType": "Other",
* "name": "string",
* "title": "string",
* "firstNames": "string",
* "firstName": "string",
* "middleName": "string",
* "surname": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "gender": "Unknown",
* "birthName": "string",
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "placeOfBirth": "string",
* "nationality": "string",
* "countryOfResidence": "string",
* "country": "AF",
* "directorType": "Other",
* "hasNegativeInfo": true,
* "signingAuthority": true,
* "positions": [
* {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { }
}
],
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
}
]
},
* "directorships": {
* "currentDirectorships": [
* {
* "id": "string",
* "title": "string",
* "initials": "string",
* "name": "string",
* "position": {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
},
* "registrationNumber": "string",
* "companyName": "string",
* "status": {
* "status": "Active",
* "description": "string"
}
}
],
* "previousDirectorships": [
* {
* "id": "string",
* "title": "string",
* "initials": "string",
* "name": "string",
* "position": {
* "dateAppointed": "2019-08-24T14:15:22Z",
* "commonCode": "string",
* "providerCode": "string",
* "positionName": "string",
* "authority": "string",
* "apptDurationType": "string",
* "additionalData": { },
* "resignationDate": "2019-08-24T14:15:22Z"
},
* "registrationNumber": "string",
* "companyName": "string",
* "status": {
* "status": "Active",
* "description": "string"
}
}
]
},
* "otherInformation": {
* "bankers": [
* {
* "name": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "bankCode": "string",
* "bic": "string"
}
],
* "advisors": [
* {
* "auditorName": "string",
* "solicitorName": "string",
* "accountantName": "string"
}
],
* "employeesInformation": [
* {
* "year": 0,
* "numberOfEmployees": "string"
}
]
},
* "groupStructure": {
* "ultimateParent": {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
},
* "immediateParent": {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
},
* "subsidiaryCompanies": [
* {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
}
],
* "affiliatedCompanies": [
* {
* "id": "string",
* "country": "AF",
* "regNo": "string",
* "safeNo": "string",
* "idType": "Other",
* "name": "string",
* "type": "NotSet",
* "officeType": "Registered",
* "status": "Active",
* "vatNo": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "activity": {
* "code": "string",
* "industrySector": "string",
* "description": "string",
* "classification": "string"
},
* "legalForm": "string",
* "additionalData": { }
}
]
},
* "extendedGroupStructure": [
* {
* "id": "string",
* "country": "string",
* "safeNumber": "string",
* "idType": "Other",
* "companyName": "string",
* "registeredNumber": "string",
* "latestAnnualAccounts": "2019-08-24T14:15:22Z",
* "level": 0,
* "percentOfOwnership": 0,
* "status": "string",
* "commonRatingBand": "string",
* "additionalData": { }
}
],
* "financialStatements": [
* {
* "yearEndDate": "2019-08-24T14:15:22Z",
* "numberOfWeeks": 0,
* "currency": "AFA",
* "consolidatedAccounts": true,
* "profitAndLoss": {
* "revenue": 0,
* "operatingCosts": 0,
* "operatingProfit": 0,
* "wagesAndSalaries": 0,
* "pensionCosts": 0,
* "depreciation": 0,
* "amortisation": 0,
* "financialIncome": 0,
* "financialExpenses": 0,
* "extraordinaryIncome": 0,
* "extraordinaryCosts": 0,
* "profitBeforeTax": 0,
* "tax": 0,
* "profitAfterTax": 0,
* "dividends": 0,
* "minorityInterests": 0,
* "otherAppropriations": 0,
* "retainedProfit": 0
},
* "balanceSheet": {
* "landAndBuildings": 0,
* "plantAndMachinery": 0,
* "otherTangibleAssets": 0,
* "totalTangibleAssets": 0,
* "goodwill": 0,
* "otherIntangibleAssets": 0,
* "totalIntangibleAssets": 0,
* "investments": 0,
* "loansToGroup": 0,
* "otherLoans": 0,
* "miscellaneousFixedAssets": 0,
* "totalOtherFixedAssets": 0,
* "totalFixedAssets": 0,
* "rawMaterials": 0,
* "workInProgress": 0,
* "finishedGoods": 0,
* "otherInventories": 0,
* "totalInventories": 0,
* "tradeReceivables": 0,
* "groupReceivables": 0,
* "receivablesDueAfter1Year": 0,
* "miscellaneousReceivables": 0,
* "totalReceivables": 0,
* "cash": 0,
* "otherCurrentAssets": 0,
* "totalCurrentAssets": 0,
* "totalAssets": 0,
* "tradePayables": 0,
* "bankLiabilities": 0,
* "otherLoansOrFinance": 0,
* "groupPayables": 0,
* "miscellaneousLiabilities": 0,
* "totalCurrentLiabilities": 0,
* "tradePayablesDueAfter1Year": 0,
* "bankLiabilitiesDueAfter1Year": 0,
* "otherLoansOrFinanceDueAfter1Year": 0,
* "groupPayablesDueAfter1Year": 0,
* "miscellaneousLiabilitiesDueAfter1Year": 0,
* "totalLongTermLiabilities": 0,
* "totalLiabilities": 0,
* "calledUpShareCapital": 0,
* "sharePremium": 0,
* "revenueReserves": 0,
* "otherReserves": 0,
* "totalShareholdersEquity": 0
},
* "otherFinancials": {
* "contingentLiabilities": "string",
* "workingCapital": 0,
* "netWorth": 0
},
* "ratios": {
* "preTaxProfitMargin": 0,
* "returnOnCapitalEmployed": 0,
* "returnOnTotalAssetsEmployed": 0,
* "returnOnNetAssetsEmployed": 0,
* "salesOrNetWorkingCapital": 0,
* "stockTurnoverRatio": 0,
* "debtorDays": 0,
* "creditorDays": 0,
* "currentRatio": 0,
* "liquidityRatioOrAcidTest": 0,
* "currentDebtRatio": 0,
* "gearing": 0,
* "equityInPercentage": 0,
* "totalDebtRatio": 0
}
}
],
* "localFinancialStatements": [
* {
* "yearEndDate": "2019-08-24T14:15:22Z",
* "numberOfWeeks": 0,
* "currency": "AFA",
* "consolidatedAccounts": true
}
],
* "negativeInformation": { },
* "additionalInformation": { },
* "directorsExtra": { },
* "extendedGroupStructureExtra": { },
* "paymentData": { },
* "paymentDataExtra": { },
* "alternateSummary": { },
* "negativeInformationExtra": { }
},
* "companyID": "string",
* "dateOfOrder": "2019-08-24T14:15:22Z",
* "language": "string",
* "userID": 0
}
GLOBAL MONITORING
Endpoints to Monitor changes to Company Information. Company changes can be
retrieved by creating a Portfolio (a collection of companies) and configuring
the eventRules (the criteria in which to trigger a change, e.g. company name
changes, limit changes) on the portfolio. When a company in your Portfolio
changes to satisfy an eventRule, a notificationEvent will be raised to inform
you of the nature of the change. See here for Creditsafe's Global Monitoring
capabilities.
MONITORING USER DETAILS
get/monitoring/user/details
https://connect.creditsafe.com/v1/monitoring/user/details
https://connect.sandbox.creditsafe.com/v1/monitoring/user/details
Returns all user details relating to the Global Monitoring product.
AUTHORIZATIONS:
bearerToken
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "countryCode": "US",
* "createdDate": "2020-01-01T00:00:00",
* "csCustomerId": 101662701,
* "csUserId": 101445010,
* "isAutoTracker": false,
* "languageCode": "en",
* "lastAccessDate": "2020-02-01T14:30:00",
* "modifiedDate": "2020-02-01T14:30:00",
* "contractEndDate": "2021-01-01T00:00:00",
* "userId": 10804
}
]
LIST COMPANY EVENTS
get/monitoring/companies/{id}/events
https://connect.creditsafe.com/v1/monitoring/companies/{id}/events
https://connect.sandbox.creditsafe.com/v1/monitoring/companies/{id}/events
Endpoint to return a collection of events for the given company, optionally
filtered on the supplied search criteria. Event information will only be
returned if the company exists in at least one of your portfolios.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
id
required
string
The connectId of the company that you wish to retrieve events for.
QUERY PARAMETERS
startDate
string <date-time>
The start date on which results are filtered.
endDate
string <date-time>
The end date on which results are filtered.
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "totalCount": 1,
* "data": [
* {
* "eventId": 192873729,
* "companyId": "UK00004371",
* "portfolioId": 589960,
* "ruleName": "Credit Limit Change",
* "localEventCode": "CL",
* "globalEventCode": "CL",
* "newValue": 7050000,
* "oldValue": 6100000,
* "eventDate": "2019-03-14T22:21:50",
* "createdDate": "2019-03-14T22:21:50"
}
],
* "paging": {
* "size": 10,
* "prev": 0,
* "next": 2,
* "last": 3
}
}
ALL EVENTRULES
get/monitoring/eventRules
https://connect.creditsafe.com/v1/monitoring/eventRules
https://connect.sandbox.creditsafe.com/v1/monitoring/eventRules
Get all available notification event rules. Notification event rules allow you
to control which events you wish to monitor for the companies contained within a
given portfolio.
AUTHORIZATIONS:
bearerToken
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "isActive": 0,
* "ruleCode": 101,
* "ruleCountryCode": "XX",
* "ruleType": 4,
* "ruleTypeName": "Rating band change - 3 input",
* "name": "International Rating | Reduce by {0} Band(s) OR Less than Band
{1}",
* "param0": "1",
* "param1": "A"
}
]
FILTERED EVENTRULES
get/monitoring/eventRules/{countryCode}
https://connect.creditsafe.com/v1/monitoring/eventRules/{countryCode}
https://connect.sandbox.creditsafe.com/v1/monitoring/eventRules/{countryCode}
Get all available notification event rules for the given countryCode.
Notification event rules allow you to control which events you wish to monitor
for the companies contained within a given portfolio.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
countryCode
required
string = 2 characters
ISO/Alpha 2 format country code for which notification event rules will be
returned.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "isActive": 0,
* "ruleCode": 101,
* "ruleCountryCode": "XX",
* "ruleType": 4,
* "ruleTypeName": "Rating band change - 3 input",
* "name": "International Rating | Reduce by {0} Band(s) OR Less than Band
{1}",
* "param0": "1",
* "param1": "A"
}
]
ALL NOTIFICATION EVENTS
get/monitoring/notificationEvents
https://connect.creditsafe.com/v1/monitoring/notificationEvents
https://connect.sandbox.creditsafe.com/v1/monitoring/notificationEvents
Get all notification events generated for companies monitored in your
portfolios, based on the notification rules enabled. The notification events
returned will be filtered based upon the supplied search criteria.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
searchQuery
string
Return notificationEvents that match the given value
sortBy
string
Default: "companyName"
Enum: "companyName" "countryCode" "eventId" "eventDate"
Sort results by this column. Null values of sort column are listed after
non-nulls.
sortDir
string
Default: "asc"
Enum: "asc" "desc"
The direction that you wish to sort results by.
startDate
string <date-time>
The start date on which results are filtered.
endDate
string <date-time>
The end date on which results are filtered.
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
filterByCreatedDate
boolean
Default: false
Enum: false true
Set to true to filter the Notification Events of the "createdDate" field when
using startDate and endDate parameters. By default this is set to false, with
the date parameters filtering using the "eventDate" field.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "totalCount": 36,
* "data": [
* {
* "company": {
* "id": "US-X-US22384484",
* "safeNumber": "US22384484",
* "name": "GOOGLE LLC",
* "countryCode": "US",
* "portfolioId": 589960,
* "portfolioName": "Default"
},
* "eventId": 426992366,
* "eventDate": "2019-12-06T08:23:37",
* "newValue": "1600 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW, CA, 94043-1351",
* "oldValue": "1604 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW, CA, 94043-1351",
* "notificationEventId": 51861887,
* "notificationId": null,
* "processedDate": null,
* "ruleCode": 105,
* "ruleName": "Address",
* "summary": "Address Change reported",
* "ruleText": "Address Change reported",
* "localEventCode": "LI2013",
* "isProcessed": true
}
],
* "paging": {
* "size": 10,
* "prev": 0,
* "next": 2,
* "last": 3
}
}
LIST ALL PORTFOLIOS
get/monitoring/portfolios
https://connect.creditsafe.com/v1/monitoring/portfolios
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios
Endpoint to get all Portfolios for the user if no query parameters are provided.
Can be searched by using the query parameter in the URL.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
searchQuery
string
Return portfolios that match the given value
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "totalCount": 1,
* "paging": {
* "size": 10,
* "prev": 0,
* "next": 2,
* "last": 3
},
* "data": {
* "portfolios": [
* {
* "portfolioId": 131318,
* "name": "Customers 2",
* "isDefault": false,
* "isSharedPortfolio": 1
}
],
* "sharedPortfolios": [
* {
* "portfolioId": 131318,
* "name": "Customers 2"
}
]
}
}
CREATE MONITORING PORTFOLIO
post/monitoring/portfolios
https://connect.creditsafe.com/v1/monitoring/portfolios
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios
Endpoint to create a new Portfolio based on the supplied criteria. A portfolio
can contain any number of companies that you wish to monitor changes to. The
only required Body parameter is "name" for Connect users.
AUTHORIZATIONS:
bearerToken
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
name
required
string
isDefault
boolean
emails
object
emailSubject
string
emailLanguage
string
frequency
string
RESPONSES
200
400
401
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "name": "My New Portfolio"
}
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
{
* "correlationId": "14cc64a0-c108-11ea-b9af-06bcc69a383e",
* "portfolioId": 131318,
* "name": "My New Portfolio",
* "isDefault": false
}
RETRIEVE PORTFOLIO BY ID
get/monitoring/portfolios/{portfolioId}
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}
Get the portfolio details such as name and default status with portfolioId.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier for the portfolio that you wish to retrieve, obtained from
/portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "portfolioId": 36,
* "name": "Customers 2",
* "isDefault": false
}
DELETE PORTFOLIO
delete/monitoring/portfolios/{portfolioId}
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}
Delete the portfolio with portfolioId
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio that you wish to delete, obtained from
/portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
{
* "message": "Portfolio removed"
}
UPDATE PORTFOLIO DETAILS
patch/monitoring/portfolios/{portfolioId}
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}
Update Portfolio details such as Name, email recipients, language and subject
line.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
name
required
string
isDefault
boolean
emails
Array of objects (Connect.Monitoring.UpdatePortfolioRequestEmail)
emailSubject
string
emailLanguage
string
frequency
string
RESPONSES
204
No Content
400
401
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "name": "New portfolio Name",
* "emails": [
* {
* "firstName": "John",
* "lastName": "Smith",
* "emailAddress": "john.smith@creditsafe.com"
}
]
}
RESPONSE SAMPLES
* 204
* 400
* 401
* 404
Content type
application/json
Copy
{
* "message": "string"
}
LIST COUNTRIES OF MONITORED COMPANIES
get/monitoring/portfolios/{portfolioId}/countries
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/countries
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/countries
Get a list of distinct countries of companies monitored within a portfolio.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
[
* "FR",
* "LU",
* "DE"
]
LIST PORTFOLIO EVENTRULES
get/monitoring/portfolios/{portfolioId}/eventRules
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules
Get all notification eventRules for the given portfolioId. Notification event
rules allow you to control which events you wish to monitor for the companies
contained within the given portfolio.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier for the portfolio that you wish to retrieve notification
event rules for, obtained from /portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "isActive": 0,
* "ruleCode": 101,
* "ruleCountryCode": "XX",
* "ruleType": 4,
* "ruleTypeName": "Rating band change - 3 input",
* "name": "International Rating | Reduce by {0} Band(s) OR Less than Band
{1}",
* "param0": "1",
* "param1": "A",
* "param2": "A"
}
]
LIST PORTFOLIO EVENTRULES BY COUNTRY
get/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}
Endpoint to that lists all the eventRules, their status and parameters based on
a portfolio Id, filtered by country. Newly created portfolios are without any
notification event rules by default, but you can switch rules on/off per country
or on a global basis. There are different rules available for each country due
to the different type of change event data that's available. The following GET
request lists all the available rules for a portfolio.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
countryCode
required
string = 2 characters
Country code to show events for.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "isActive": 0,
* "ruleCode": 101,
* "ruleCountryCode": "XX",
* "ruleType": 4,
* "ruleTypeName": "Rating band change - 3 input",
* "name": "International Rating | Reduce by {0} Band(s) OR Less than Band
{1}",
* "param0": "1",
* "param1": "A",
* "param2": "A"
}
]
UPDATE EVENTRULES
put/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/{countryCode}
Endpoint to update an eventRule in a portfolio. Must provide a portfolio unique
identifier and a country code in the URL of the PUT request. The Body of the
request must contain the ruleCode number of the eventRule you want to update,
with an isActive parameter. Some event rules may also contain specific
parameters, which can be set with param0, param1 and param2. parameters. Get the
above information by calling the List All eventRules endpoint.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
countryCode
required
string = 2 characters
Country code to show events for
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
Array
ruleCode
required
integer
The unique ID of the EventRule
isActive
required
integer
Flag to show if EventRule is active or not. 0 for false, 1 for true.
param0
string
param1
string
param2
string
RESPONSES
204
No Content
400
401
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "ruleCode": 101,
* "isActive": 1,
* "param0": true,
* "param1": "15",
* "param2": "10"
},
* {
* "ruleCode": 1802,
* "isActive": 1,
* "param0": "10"
},
* {
* "ruleCode": 1815,
* "isActive": 0
}
]
RESPONSE SAMPLES
* 204
* 400
* 401
* 404
Content type
application/json
Copy
{
* "message": "string"
}
SET PORTFOLIO DEFAULT RULES
put/monitoring/portfolios/{portfolioId}/eventRules/setDefault
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/setDefault
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/eventRules/setDefault
Update a portfolios event rules to default state. In Connect, default state
means all rules are turned off.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
204
No Content
400
401
404
RESPONSE SAMPLES
* 204
* 400
* 401
* 404
Content type
application/json
Copy
{
* "message": "string"
}
PORTFOLIO RISK SUMMARY
get/monitoring/portfolios/{portfolioId}/riskSummary
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/riskSummary
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/riskSummary
Get current portfolio risk summary information
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "totalCompanies": 66,
* "bandACount": 20,
* "bandApc": 40.625,
* "bandBCount": 17,
* "bandBpc": 26.5625,
* "bandCCount": 14,
* "bandCpc": 21.8775,
* "bandDCount": 5,
* "bandDpc": 7.8125,
* "bandECount": 2,
* "bandEpc": 3.125
}
LIST PORTFOLIO NOTIFICATIONS
get/monitoring/portfolios/{portfolioId}/notificationEvents
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/notificationEvents
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/notificationEvents
Get all notificationEvents based on the portfolio id, optionally filter with
query parameters
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
QUERY PARAMETERS
searchQuery
string
Return notificationEvents that match the given value
sortBy
string
Default: "companyName"
Enum: "companyName" "countryCode" "eventId" "eventDate"
Sort results by this column. Null values of sort column are listed after
non-nulls.
sortDir
string
Default: "asc"
Enum: "asc" "desc"
The direction that you wish to sort results by.
pageSize
integer
Number of items to return per Page.
page
integer
Default: 1
Starting page number.
startDate
string <date-time>
The start date on which results are filtered.
endDate
string <date-time>
The end date on which results are filtered.
filterByCreatedDate
boolean
Default: false
Enum: false true
Set to true to filter the Notification Events of the "createdDate" field when
using startDate and endDate parameters. By default this is set to false, with
the date parameters filtering using the "eventDate" field.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "totalCount": 36,
* "data": [
* {
* "company": {
* "id": "US-X-US22384484",
* "safeNumber": "US22384484",
* "name": "GOOGLE LLC",
* "countryCode": "US",
* "portfolioId": 589960,
* "portfolioName": "Default"
},
* "eventId": 426992366,
* "eventDate": "2019-12-06T08:23:37",
* "newValue": "1600 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW, CA, 94043-1351",
* "oldValue": "1604 AMPHITHEATRE PARKWAY, MOUNTAIN VIEW, CA, 94043-1351",
* "notificationEventId": 51861887,
* "notificationId": null,
* "processedDate": null,
* "ruleCode": 105,
* "ruleName": "Address",
* "summary": "Address Change reported",
* "ruleText": "Address Change reported",
* "localEventCode": "LI2013",
* "isProcessed": true
}
],
* "paging": {
* "size": 10,
* "prev": 0,
* "next": 2,
* "last": 3
}
}
UPDATE ISPROCESSED FLAG
patch/monitoring/portfolios/{portfolioId}/notificationEvents/{notificationEventId}
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/notificationEvents/{notificationEventId}
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/notificationEvents/{notificationEventId}
WARNING - This endpoint will depreciate during the last week of January 2021 and
will not be usable anymore. We recommend to utilize the filterByCreatedDate path
parameter on the /notificationEvents endpoints to return exact Notification
Events that have triggered on the specific day/date range.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
notificationEventId
required
number
A unique notification event ID.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
isProcessed
boolean
RESPONSES
200
400
401
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "isProcessed": true
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "data": {
* "message": "Update successful"
}
}
LIST COMPANIES IN A PORTFOLIO
get/monitoring/portfolios/{portfolioId}/companies
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies
Get all companies from a specific portfolio based on the portfolio id,
optionally filter with query parameters.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
QUERY PARAMETERS
searchQuery
string
Return companies that match the given value
pageSize
integer
Number of items to return per Page.
page
integer
Default: 1
Starting page number.
countryCode
string
Return <> that match the given countryCode
events
boolean
Default: false
If set to true, all events will be returned for each company
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "totalCount": 1,
* "paging": {
* "size": 10,
* "prev": 0,
* "next": 2,
* "last": 3
},
* "data": [
* {
* "id": "US-X-US22384484",
* "safeNumber": "US22384484",
* "name": "GOOGLE LLC",
* "address": "VIA PABLO NERUDA, 4, TREZZANO SUL NAVIGLIO, 20090",
* "countryCode": "US",
* "portfolioId": 589960,
* "creditLimit": 10000,
* "dateLastEvent": "2018-06-14T00:59:06",
* "freeText": null,
* "personalLimit": 10000,
* "personalReference": "Follow up Jan 2021",
* "ratingCommon": "A",
* "ratingLocal": "Not rated - insufficient information to rate",
* "companyStatus": 1
}
]
}
ADD COMPANY TO PORTFOLIO
post/monitoring/portfolios/{portfolioId}/companies
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies
Endpoint to add a company using a company id, into a portfolio provided in as a
path parameter. Optional fields can be used to add a personalReference,
freeText, and personalLimit.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
id
required
string
The company Safe Number or Connect ID
personalReference
required
string
freeText
required
string
personalLimit
required
string
RESPONSES
200
400
401
404
409
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "id": "GB-0-12345678",
* "personalReference": "Some text",
* "freeText": "Some useful test",
* "personalLimit": "40"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
* 409
Content type
application/json
Copy
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "message": "Company Added"
}
COPY COMPANIES BETWEEN PORTFOLIOS
post/monitoring/portfolios/{portfolioId}/companies/copy
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/copy
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/copy
Copy companies from one portfolio to single (or) multiple portfolios.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio you want to copy companies from, obtained
from /portfolios.
QUERY PARAMETERS
copyAll
boolean
Default: false
When CopyAll query parameter is False, portfolios and companies list needs to be
passed. When CopyAll query parameter is True, only portfolios need to be passed
and companies List must be empty. All companies are copied from current
portfolio are considered here.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
portfolios
Array of integers
companies
Array of objects (Connect.Monitoring.CopyAndMoveCompaniesBodyCompanies)
RESPONSES
200
400
401
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "portfolios": [
* 196854,
* 197369
],
* "companies": [
* {
* "id": "BE-X-733313367"
},
* {
* "id": "BE-X-868222848"
},
* {
* "id": "BE-X-835695382"
}
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "data": {
* "totalPortfoliosCompanies": 5,
* "successfulPortfoliosCompanies": 3,
* "failedPortfoliosCompanies": 2,
* "reason": "Duplicate entry '199483-FR00002855' for key 'PRIMARY"
}
}
MOVE COMPANIES BETWEEN PORTFOLIOS
post/monitoring/portfolios/{portfolioId}/companies/remove
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/remove
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/remove
Move companies from one portfolio to single (or) multiple portfolios. Removes
the companies from the portfolio provided in the path parameter.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio you want to move companies from, obtained
from /portfolios.
QUERY PARAMETERS
removeAll
boolean
Default: false
When RemoveAll query parameter is False, portfolios and companies List needs to
be passed. When RemoveAll query parameter is True, only portfolios need to be
passed and companies List must be empty. All companies are moved and deleted
from current portfolio.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
portfolios
Array of integers
companies
Array of objects (Connect.Monitoring.CopyAndMoveCompaniesBodyCompanies)
RESPONSES
200
400
401
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "portfolios": [
* 196854,
* 197369
],
* "companies": [
* {
* "id": "BE-X-733313367"
},
* {
* "id": "BE-X-868222848"
},
* {
* "id": "BE-X-835695382"
}
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "data": {
* "totalPortfoliosCompanies": 5,
* "successfulPortfoliosCompanies": 3,
* "failedPortfoliosCompanies": 2,
* "reason": "Duplicate entry '199483-FR00002855' for key 'PRIMARY"
}
}
CLEAR COMPANIES FROM PORTFOLIO
patch/monitoring/portfolios/{portfolioId}/companies/clear
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/clear
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/clear
Delete companies from current portfolio
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio you want to delete companies from,
obtained from /portfolios.
QUERY PARAMETERS
clearAll
boolean
Default: false
When ClearAll query parameter is False,Companies List needs to be passed. When
ClearAll query parameter is True, Companies List must be empty. All companies
will be deleted
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
companies
Array of strings
RESPONSES
200
400
401
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "companies": [
* "BE-X-733313367",
* "BE-X-868222848"
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "message": "Companies deleted from portfolio"
}
GET COMPANY DETAILS FROM A PORTFOLIO
get/monitoring/portfolios/{portfolioId}/companies/{companyId}
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{companyId}
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{companyId}
Get various company details from a portfolio. Requires a portfolioID and
companyID in the PATH of the request.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
companyId
required
string
A company Safe Number or Connect ID.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "id": "US-X-US22384484",
* "safeNumber": "US22384484",
* "name": "GOOGLE LLC",
* "address": "VIA PABLO NERUDA, 4, TREZZANO SUL NAVIGLIO, 20090",
* "countryCode": "US",
* "portfolioId": 589960,
* "creditLimit": 10000,
* "dateLastEvent": "2018-06-14T00:59:06",
* "freeText": null,
* "personalLimit": 10000,
* "personalReference": "Follow up Jan 2021",
* "ratingCommon": "A",
* "ratingLocal": "Not rated - insufficient information to rate",
* "companyStatus": 1
}
DELETE COMPANY FROM PORTFOLIO
delete/monitoring/portfolios/{portfolioId}/companies/{companyId}
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{companyId}
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{companyId}
Endpoint to delete a company from a portfolio.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
companyId
required
string
A company Safe Number or Connect ID.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
403
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 404
Content type
application/json
Copy
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "message": "Company removed"
}
UPDATE COMPANY DETAILS IN PORTFOLIO
patch/monitoring/portfolios/{portfolioId}/companies/{companyId}
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{companyId}
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{companyId}
Updates the company details in a specified portfolio
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
companyId
required
string
A company Safe Number or Connect ID.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
personalReference
required
string
freeText
required
string
personalLimit
required
string
RESPONSES
204
No Content
400
401
403
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "personalReference": "personal reference",
* "freeText": "Some useful text",
* "personalLimit": "40"
}
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
Content type
application/json
Copy
{
* "correlationId": "string",
* "message": "string",
* "details": "string"
}
LIST COMPANY SPECIFIC NOTIFICATIONEVENTS
get/monitoring/portfolios/{portfolioId}/companies/{id}/notificationEvents
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{id}/notificationEvents
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/companies/{id}/notificationEvents
List of notification events based on the company id,optionally filtered with
query parameters
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
string
The unique identifier of the portfolio, obtained from /portfolios.
id
required
string
A company Safe Number or Connect ID.
QUERY PARAMETERS
searchQuery
string
Return notificationEvents that match the given value
sortDir
string
Default: "asc"
Enum: "asc" "desc"
The direction that you wish to sort results by.
pageSize
integer
Default: 50
Number of items to return per Page (max 1000)
page
integer
Default: 1
Starting page number.
isProcessed
boolean
Enum: true false
A flag that can be set to true boolean value to mark it as an event that has
been actioned.
sortBy
string
Default: "companyName"
Enum: "companyName" "countryCode" "eventId" "eventDate"
Sort results by this column. Null values of sort column are listed after
non-nulls.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
204
No Content
400
401
403
404
RESPONSE SAMPLES
* 400
* 401
* 403
* 404
Content type
application/json
Copy
{
* "correlationId": "string",
* "message": "string",
* "details": "string"
}
PORTFOLIO USER PERMISSIONS
get/monitoring/portfolios/{portfolioId}/sharingPermissions
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/sharingPermissions
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/sharingPermissions
Retrieve user permissions within the customer for a portfolio
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
404
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "data": {
* "portfolioId": "13437356",
* "customerId": 101375376,
* "userPermission": [
* {
* "csUserId": 101435674,
* "userName": "UPPStage",
* "permission": "View, Add, Remove"
}
]
}
}
SHARE PORTFOLIO WITH USERS
patch/monitoring/portfolios/{portfolioId}/sharingPermissions
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/sharingPermissions
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/sharingPermissions
Update/Create user permissions within the customer for portfolio
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
revokeAll
string
If set to "true", all user permissions will be revoked for the portfolio. By
default set to "false".
userPermissions
Array of objects (Connect.Monitoring.SharePortfolioRequestBody)
RESPONSES
200
400
401
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "revokeAll": "false",
* "userPermissions": [
* {
* "csUserId": 101106166,
* "permissions": "View,Add"
},
* {
* "csUserId": 1000027380,
* "permissions": "View,Add,Edit,Remove"
}
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "data": {
* "portfolioId": "13437356",
* "customerId": 101375376,
* "status": "Success"
}
}
IMPORT A PORTFOLIO FILE
post/monitoring/portfolios/{portfolioId}/import
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/import
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/import
Endpoint allows you to import a list of companies to add to the selected
portfolio along with some personal information for the company. Importing a
portfolio will add the companies to the specified portfolio, duplicates in the
import file will be ignored.You may also optionally add an email to the body of
the request and get an email notification when the import is processed..
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: MULTIPART/FORM-DATA
importcsv
string <binary>
The import file must be in either a .csv, .xls or .xlsx.
email
string
Option field. Provide an email and get a notification when the import has been
completed with the details about the import.
RESPONSES
200
400
401
404
REQUEST SAMPLES
* Payload
Content type
multipart/form-data
Copy
{
"importCsv": "FILE_PATH",
"email": "john.smith@creditsafe.com"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "status": "Accepted for processing. Import Id 339523"
}
SYNC A PORTFOLIO FILE
post/monitoring/portfolios/{portfolioId}/sync
https://connect.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/sync
https://connect.sandbox.creditsafe.com/v1/monitoring/portfolios/{portfolioId}/sync
Endpoint allows you to sync a portfolio file with your portfolio. Sync action
will delete all companies in your specified portfolio, and then add the
companies from the file into the portfolio.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
portfolioId
required
number
The unique identifier of the portfolio, obtained from /portfolios.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: MULTIPART/FORM-DATA
importcsv
string <binary>
The import file must be in either a .csv, .xls or .xlsx.
email
string
Option field. Provide an email and get a notification when the import has been
completed with the details about the import.
RESPONSES
200
400
401
404
REQUEST SAMPLES
* Payload
Content type
multipart/form-data
Copy
{
"importCsv": "FILE_PATH",
"email": "john.smith@creditsafe.com"
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 404
Content type
application/json
Copy
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "status": "Accepted for processing. Import Id 339523"
}
DECISION ENGINE
Endpoints to access pre-configured decision trees to automate credit decisions.
Decision Engine can help you save time and money across your company by
automating time consuming processes which drain your company's resources. This
can free you and your staff to spend more time to work on achieving your
business goals.
A full audit trail of previous decisions is maintained for user access and
decisions in a pending state can be manually approved or declined.
DECISION TREES
get/decisionEngine/GUID
https://connect.creditsafe.com/v1/decisionEngine/GUID
https://connect.sandbox.creditsafe.com/v1/decisionEngine/GUID
Returns all decision trees that the user has permission to access.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
type
string
Enum: "Credit Approval" "Bespoke" "Demo"
Filter the returned decision trees by their associated decision tree type.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "GUIDList": [
* {
* "friendlyName": "Check & Decide Demo",
* "GUID": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
* "type": "Credit Approval",
* "serviceLine": "dec_eng_cas"
}
]
}
USER DATA FIELDS
get/decisionEngine/{provenirId}/userDataFields
https://connect.creditsafe.com/v1/decisionEngine/{provenirId}/userDataFields
https://connect.sandbox.creditsafe.com/v1/decisionEngine/{provenirId}/userDataFields
Returns the user data fields defined for the given decision tree GUID.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
provenirId
required
string
The unique identifier of the decision tree, obtained from /GUID.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "decisionEngineId": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
* "fields": [
* {
* "orderIndex": 100,
* "label": "Product Type",
* "paramName": "productType",
* "fieldType": "Dropdown",
* "mandatory": true,
* "dropdownDetails": [
* {
* "label": "Product A",
* "presentationOrder": 100
}
],
* "validation": [
* {
* "validationType": "Minimum",
* "validationValue": 100,
* "description": "Minimum Sales Value $100"
}
]
}
]
}
RUN DECISION TREE
post/decisionEngine/{provenirId}
https://connect.creditsafe.com/v1/decisionEngine/{provenirId}
https://connect.sandbox.creditsafe.com/v1/decisionEngine/{provenirId}
Runs the provided decision tree for the given company, optionally using the data
provided in the body of the call.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
provenirId
required
string
The unique identifier of the decision tree to run, obtained from /GUID.
QUERY PARAMETERS
companyId
required
string
Example: companyId=GB-0-03836192
The Connect ID for the company that you wish to run the decision tree on.
Obtained from /companies search results. A Connect ID is the primary Company
identifier that is used to uniquely identify all companies across Creditsafe's
Universe and Partner Network.
originationId
string
Example: originationId=SFC-1976
An optional field that will allow text passed through to be stored against the
decision. Typically used for internal identifiers (e.g. SalesForce IDs).
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
object
The POST body should contain the User Data Fields for the decision tree you want
to run obtained via the /{guid}/userDataFields endpoint.
RESPONSES
200
400
401
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "productType": "Product A",
* "isCustomer": "Yes",
* "salesValue": 197600
}
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "Decision": "Reject",
* "DecisionText": "The Sales Value requested is greater than Creditsafe's
recommended credit limit.",
* "Audits": [
* {
* "description": "A",
* "RuleName": "International Score"
}
],
* "originationId": "SFC-1976",
* "statusCode": 3
}
DECISION HISTORY
get/decisionEngine/usageLog
https://connect.creditsafe.com/v1/decisionEngine/usageLog
https://connect.sandbox.creditsafe.com/v1/decisionEngine/usageLog
Returns a log of all previously ran decisions that the user has permission to
access, optionally filtered.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
provenirId
string
Example: provenirId=repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9
Filter the returned usage log by the GUID for the associated decision trees,
obtained from /GUID.
companyId
string
Example: companyId=US001-X-US60521352
Filter the returned usage log by the Connect ID for the associated companies for
each decision.
companyName
string
Example: companyName=CREDITSAFE
Filter the returned usage log by the Company Name for the associated companies
for each decision.
status
number
Example: status=1
Filter the returned usage log by the status for each decision.
fromDate
string <date-time>
Filter the returned usage log by the date the the decision was run.
toDate
string <date-time>
Filter the returned usage log by the date the the decision was run.
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "totalCount": 3108,
* "usageLog": [
* {
* "decisionLogId": 64492,
* "provenirId": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
* "friendlyName": "Check & Decide Demo",
* "userId": 101445010,
* "companyId": "US001-X-US60521352",
* "companyName": "CREDITSAFE USA INC.",
* "response": {
* "Decision": "Reject",
* "DecisionText": "The Sales Value requested is greater than
Creditsafe's recommended credit limit.",
* "Audits": [
* {
* "description": "A",
* "RuleName": "International Score"
}
],
* "originationId": "SFC-1976",
* "statusCode": 3
},
* "decisionDate": "2019-08-24T14:15:22Z",
* "notes": "string",
* "status": 3
}
]
}
GET DECISION LOG
get/decisionEngine/usageLog/{decisionLogId}
https://connect.creditsafe.com/v1/decisionEngine/usageLog/{decisionLogId}
https://connect.sandbox.creditsafe.com/v1/decisionEngine/usageLog/{decisionLogId}
Returns a specified decision log for a previously ran decision.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
decisionLogId
required
string
The unique identifier of the decision log to retrieve, obtained from /usageLog.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "decisionLogId": 64492,
* "provenirId": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
* "friendlyName": "Check & Decide Demo",
* "userId": 101445010,
* "companyId": "US001-X-US60521352",
* "companyName": "CREDITSAFE USA INC.",
* "response": {
* "Decision": "Reject",
* "DecisionText": "The Sales Value requested is greater than Creditsafe's
recommended credit limit.",
* "Audits": [
* {
* "description": "A",
* "RuleName": "International Score"
}
],
* "statusCode": 3
},
* "decisionDate": "2019-08-24T14:15:22Z",
* "originationId": "SFC-1976",
* "status": 3,
* "notes": "string",
* "modifiedDate": "2019-08-24T14:15:22Z"
}
UPDATE DECISION LOG
patch/decisionEngine/usageLog/{decisionLogId}
https://connect.creditsafe.com/v1/decisionEngine/usageLog/{decisionLogId}
https://connect.sandbox.creditsafe.com/v1/decisionEngine/usageLog/{decisionLogId}
Updates the status and/or notes for a specified decision.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
decisionLogId
required
string
The unique identifier of the decision log to retrieve, obtained from /usageLog.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
statusCode
number
The status that the decision will be updated to. Typically, 1 is reserved for
positive outcomes, 2 for pending status and 3 for negative outcomes.
notes
string
Free text field to allow for the saving of notes on the associated decision
object.
RESPONSES
200
400
401
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "statusCode": 1,
* "notes": "Manually approved by Senior Credit Controller."
}
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "correlationId": "23921650-c073-11ea-860f-06bc8182190e",
* "decisionLogId": 64492,
* "provenirId": "repoObj_0ed6a4aa_16e17d977e9_07ffb16e17d977e9",
* "friendlyName": "Check & Decide Demo",
* "userId": 101445010,
* "companyId": "US001-X-US60521352",
* "companyName": "CREDITSAFE USA INC.",
* "response": {
* "Decision": "Reject",
* "DecisionText": "The Sales Value requested is greater than Creditsafe's
recommended credit limit.",
* "Audits": [
* {
* "description": "A",
* "RuleName": "International Score"
}
],
* "statusCode": 3
},
* "decisionDate": "2019-08-24T14:15:22Z",
* "originationId": "SFC-1976",
* "status": 3,
* "notes": "string",
* "modifiedDate": "2019-08-24T14:15:22Z"
}
PROTECT
The focus on screening clients and third parties is increasing. International
regulators are demanding that firms improve their ongoing sanctions screening
process. LexisNexis World Compliance data through Connect allows customers to
mitigate risk around Anti-Bribery and Corruption under local and international
regulations such as the UK Bribery Act, by enabling users to screen their third
party agents, suppliers or employees against watch lists. With LexisNexis World
Compliance through Creditsafe Connect, compliance is easy, efficient and
cost-effective, even as the regulatory mountain grows.
CREATE PROTECT INVESTIGATION
post/protect/investigations
https://connect.creditsafe.com/v1/protect/investigations
https://connect.sandbox.creditsafe.com/v1/protect/investigations
Creates an Investigation according to the provided Investigation criteria. Each
result is potential match which is attributed a relevancy/match score between
1-100 and a high level reason for it's inclusion in the World Compliance
Database by looking at the Reason Listed and Comments to firstly ascertain
whether the entry is a match for you search criteria and then utilize the data
available for your own onboarding needs.
AUTHORIZATIONS:
bearerToken
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
type
string
Enum: "business" "individual"
name
string or null
houseNo
string or null
street
string or null
province
string or null
city
string or null
postCode
string or null
countryCode
string or null
firstName
string or null
middleName
string or null
lastName
string or null
generation
string or null
dateOfBirth
string or null
nationalId
string or null
citizenship
string or null
phoneNo
string or null
RESPONSES
201
400
default
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "type": "business",
* "name": "string",
* "houseNo": "string",
* "street": "string",
* "province": "string",
* "city": "string",
* "postCode": "string",
* "countryCode": "string",
* "firstName": "string",
* "middleName": "string",
* "lastName": "string",
* "generation": "string",
* "dateOfBirth": "string",
* "nationalId": "string",
* "citizenship": "string",
* "phoneNo": "string"
}
RESPONSE SAMPLES
* 201
* 400
* default
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "createdAt": "2019-08-24T14:15:22Z",
* "createdBy": 0,
* "searchCriteria": {
* "type": "Business",
* "name": "string",
* "houseNo": "string",
* "street": "string",
* "province": "string",
* "city": "string",
* "postCode": "string",
* "countryCode": "string",
* "firstName": "string",
* "middleName": "string",
* "lastName": "string",
* "generation": "string",
* "dateOfBirth": "string",
* "nationalId": "string",
* "citizenship": "string",
* "phoneNo": "string"
},
* "scheduleId": "string",
* "profileId": "string",
* "profileName": "string",
* "alertsCount": 0,
* "results": [
* {
* "id": 0,
* "entityId": "string",
* "matchScore": 0,
* "sourceDate": "string",
* "dateListed": "string",
* "name": "string",
* "fullName": "string",
* "firstName": "string",
* "middleName": "string",
* "lastName": "string",
* "reasonListed": "string",
* "entityType": "string",
* "dateOfBirth": "string",
* "generation": "string",
* "gender": "string",
* "occupation": "string",
* "placeOfBirth": "string",
* "hasAdverseMedia": true,
* "otherNames": [
* "string"
],
* "addresses": [
* {
* "street": "string",
* "city": "string",
* "province": "string",
* "postCode": "string",
* "country": "string"
}
],
* "comments": [
* "string"
],
* "sources": [
* "string"
]
}
]
}
LIST ALL PROTECT INVESTIGATIONS
get/protect/investigations
https://connect.creditsafe.com/v1/protect/investigations
https://connect.sandbox.creditsafe.com/v1/protect/investigations
Endpoint to return all investigations. Filter response by using query
parameters. Use the alertsCount parameter to only return Investigations with
alerts greater than the supplied value.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
scheduled
boolean
alertsCount
integer or null <int32>
query.type
object (Connect.Protect.CreateInvestigationQueryDto)
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "id": "string",
* "createdAt": "2019-08-24T14:15:22Z",
* "userId": 0,
* "customerId": 0,
* "query": {
* "type": "Business",
* "name": "string",
* "houseNo": "string",
* "street": "string",
* "province": "string",
* "city": "string",
* "postCode": "string",
* "countryCode": "string",
* "firstName": "string",
* "middleName": "string",
* "lastName": "string",
* "generation": "string",
* "dateOfBirth": "string",
* "nationalId": "string",
* "citizenship": "string",
* "phoneNo": "string"
},
* "scheduleId": "string",
* "scheduledOn": "2019-08-24T14:15:22Z",
* "profileId": "string",
* "profileName": "string",
* "alertCreatedAt": "2019-08-24T14:15:22Z",
* "alertsCount": 0
}
]
RETRIEVE PROTECT INVESTIGATION BY ID
get/protect/investigations/{investigationId}
https://connect.creditsafe.com/v1/protect/investigations/{investigationId}
https://connect.sandbox.creditsafe.com/v1/protect/investigations/{investigationId}
Endpoint to retrieve a specific Investigation by ID. Can also be used to
retrieve the associated Schedule Id that has been linked to the Investigation.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
investigationId
required
string <guid>
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
404
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "createdAt": "2019-08-24T14:15:22Z",
* "createdBy": 0,
* "searchCriteria": {
* "type": "Business",
* "name": "string",
* "houseNo": "string",
* "street": "string",
* "province": "string",
* "city": "string",
* "postCode": "string",
* "countryCode": "string",
* "firstName": "string",
* "middleName": "string",
* "lastName": "string",
* "generation": "string",
* "dateOfBirth": "string",
* "nationalId": "string",
* "citizenship": "string",
* "phoneNo": "string"
},
* "scheduleId": "string",
* "profileId": "string",
* "profileName": "string",
* "alertsCount": 0,
* "results": [
* {
* "id": 0,
* "entityId": "string",
* "matchScore": 0,
* "sourceDate": "string",
* "dateListed": "string",
* "name": "string",
* "fullName": "string",
* "firstName": "string",
* "middleName": "string",
* "lastName": "string",
* "reasonListed": "string",
* "entityType": "string",
* "dateOfBirth": "string",
* "generation": "string",
* "gender": "string",
* "occupation": "string",
* "placeOfBirth": "string",
* "hasAdverseMedia": true,
* "otherNames": [
* "string"
],
* "addresses": [
* {
* "street": "string",
* "city": "string",
* "province": "string",
* "postCode": "string",
* "country": "string"
}
],
* "comments": [
* "string"
],
* "sources": [
* "string"
]
}
]
}
LIST ALL PROTECT PROFILES
get/protect/profiles
https://connect.creditsafe.com/v1/protect/profiles
https://connect.sandbox.creditsafe.com/v1/protect/profiles
Returns all profiles or filtered with a matching profile name.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
name
string or null
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "id": "string",
* "userId": 0,
* "customerId": 0,
* "name": "string",
* "createdAt": "2019-08-24T14:15:22Z",
* "modifiedAt": "2019-08-24T14:15:22Z"
}
]
CREATE PROTECT PROFILE
post/protect/profiles
https://connect.creditsafe.com/v1/protect/profiles
https://connect.sandbox.creditsafe.com/v1/protect/profiles
Creates a profile. Profiles can be used as an additional category to group
related investigations together. For instance - You may want to investigate all
Branches, Directors and Shareholders of one business, and keep them in the same
Profile.
AUTHORIZATIONS:
bearerToken
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
name
required
string
RESPONSES
201
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "name": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/json
Copy
{
* "id": "string",
* "userId": 0,
* "customerId": 0,
* "name": "string",
* "createdAt": "2019-08-24T14:15:22Z",
* "modifiedAt": "2019-08-24T14:15:22Z"
}
RETRIEVE PROTECT PROFILE BY ID
get/protect/profiles/{profileId}
https://connect.creditsafe.com/v1/protect/profiles/{profileId}
https://connect.sandbox.creditsafe.com/v1/protect/profiles/{profileId}
Endpoint to retrieve a profile by Id
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
profileId
required
string <guid>
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
404
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
{
* "id": "string",
* "userId": 0,
* "customerId": 0,
* "name": "string",
* "createdAt": "2019-08-24T14:15:22Z",
* "modifiedAt": "2019-08-24T14:15:22Z"
}
EDIT PROTECT PROFILE
put/protect/profiles/{profileId}
https://connect.creditsafe.com/v1/protect/profiles/{profileId}
https://connect.sandbox.creditsafe.com/v1/protect/profiles/{profileId}
Endpoint to change the name of a profile.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
profileId
required
string <guid>
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
name
required
string
RESPONSES
200
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "name": "string"
}
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
{
* "id": "string",
* "userId": 0,
* "customerId": 0,
* "name": "string",
* "createdAt": "2019-08-24T14:15:22Z",
* "modifiedAt": "2019-08-24T14:15:22Z"
}
LIST INVESTIGATIONS IN A PROFILE
get/protect/profiles/{profileId}/investigations
https://connect.creditsafe.com/v1/protect/profiles/{profileId}/investigations
https://connect.sandbox.creditsafe.com/v1/protect/profiles/{profileId}/investigations
Endpoint to retrieve all Investigations associated with a specific Profile.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
profileId
required
string <guid>
QUERY PARAMETERS
query.type
object (Connect.Protect.CreateInvestigationQueryDto)
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
404
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "id": "string",
* "createdAt": "2019-08-24T14:15:22Z",
* "userId": 0,
* "customerId": 0,
* "query": {
* "type": "Business",
* "name": "string",
* "houseNo": "string",
* "street": "string",
* "province": "string",
* "city": "string",
* "postCode": "string",
* "countryCode": "string",
* "firstName": "string",
* "middleName": "string",
* "lastName": "string",
* "generation": "string",
* "dateOfBirth": "string",
* "nationalId": "string",
* "citizenship": "string",
* "phoneNo": "string"
},
* "scheduleId": "string",
* "scheduledOn": "2019-08-24T14:15:22Z",
* "profileId": "string",
* "profileName": "string",
* "alertCreatedAt": "2019-08-24T14:15:22Z",
* "alertsCount": 0
}
]
ADD INVESTIGATION TO PROFILE
put/protect/profiles/{profileId}/investigations/{investigationId}
https://connect.creditsafe.com/v1/protect/profiles/{profileId}/investigations/{investigationId}
https://connect.sandbox.creditsafe.com/v1/protect/profiles/{profileId}/investigations/{investigationId}
Adds an Investigation to a Profile
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
profileId
required
string <guid>
investigationId
required
string <guid>
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
204
404
RESPONSE SAMPLES
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "type": "string",
* "title": "string",
* "status": 0,
* "detail": "string",
* "instance": "string",
* "extensions": {
* "property1": { },
* "property2": { }
}
}
CREATE PROTECT INVESTIGATION PDF
post/protect/investigations/{investigationId}/file
https://connect.creditsafe.com/v1/protect/investigations/{investigationId}/file
https://connect.sandbox.creditsafe.com/v1/protect/investigations/{investigationId}/file
Creates a LexisNexis branded PDF that shows the full report for the selected
entities. This report will include search criteria used, user, time/date stamp
and full LexisNexis World Compliance Report. It is recommended to call this
endpoint before adding InvestigationRecords to an Investigation, as only
non-processed alerts populate the PDF.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
investigationId
required
string <guid>
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
recordIds
Array of integers <int64> [ items <int64 > ]
RESPONSES
200
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "recordIds": [
* 0
]
}
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
{
* "filePath": "string"
}
LIST MATCHES PER INVESTIGATION
get/protect/investigations/{investigationId}/records
https://connect.creditsafe.com/v1/protect/investigations/{investigationId}/records
https://connect.sandbox.creditsafe.com/v1/protect/investigations/{investigationId}/records
Endpoint to return all InvestigationRecords (matches) against an Investigation.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
investigationId
required
string
QUERY PARAMETERS
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
404
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "id": 0,
* "entityId": "string",
* "matchScore": 0,
* "sourceDate": "string",
* "dateListed": "string",
* "name": "string",
* "fullName": "string",
* "firstName": "string",
* "middleName": "string",
* "lastName": "string",
* "reasonListed": "string",
* "entityType": "string",
* "dateOfBirth": "string",
* "generation": "string",
* "gender": "string",
* "occupation": "string",
* "placeOfBirth": "string",
* "hasAdverseMedia": true,
* "otherNames": [
* "string"
],
* "addresses": [
* {
* "street": "string",
* "city": "string",
* "province": "string",
* "postCode": "string",
* "country": "string"
}
],
* "comments": [
* "string"
],
* "sources": [
* "string"
]
}
]
ADD MATCH TO INVESTIGATION
post/protect/investigations/{investigationId}/records
https://connect.creditsafe.com/v1/protect/investigations/{investigationId}/records
https://connect.sandbox.creditsafe.com/v1/protect/investigations/{investigationId}/records
Endpoint to add InvestigationRecords to an Investigation. By adding
InvestigationRecords you are confirming that the result is a match to your
search criteria.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
investigationId
required
string <guid>
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
recordIds
Array of integers <int64> [ items <int64 > ]
RESPONSES
200
400
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "recordIds": [
* 0
]
}
RESPONSE SAMPLES
* 200
* 400
* 404
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "id": 0,
* "entityId": "string",
* "matchScore": 0,
* "sourceDate": "string",
* "dateListed": "string",
* "name": "string",
* "fullName": "string",
* "firstName": "string",
* "middleName": "string",
* "lastName": "string",
* "reasonListed": "string",
* "entityType": "string",
* "dateOfBirth": "string",
* "generation": "string",
* "gender": "string",
* "occupation": "string",
* "placeOfBirth": "string",
* "hasAdverseMedia": true,
* "otherNames": [
* "string"
],
* "addresses": [
* {
* "street": "string",
* "city": "string",
* "province": "string",
* "postCode": "string",
* "country": "string"
}
],
* "comments": [
* "string"
],
* "sources": [
* "string"
]
}
]
CREATE PROTECT SCHEDULE
post/protect/schedules
https://connect.creditsafe.com/v1/protect/schedules
https://connect.sandbox.creditsafe.com/v1/protect/schedules
Creates a Schedule. A Schedule has a 1:1 relationship with an Investigation.
Investigations that are scheduled will automatically check for new re-screen
your initial search criteria on a nightly basis allowing you to review any new
alerts each day.
AUTHORIZATIONS:
bearerToken
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
frequency
required
string
Value: "daily"
investigationId
string <guid>
screeningThreshold
integer <int32>
RESPONSES
201
400
404
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "investigationId": "string",
* "frequency": "daily",
* "screeningThreshold": 0
}
RESPONSE SAMPLES
* 201
* 400
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "customerId": 0,
* "userId": 0,
* "investigationId": "string",
* "investigation": {
* "id": "string",
* "createdAt": "2019-08-24T14:15:22Z",
* "userId": 0,
* "customerId": 0,
* "query": {
* "type": "Business",
* "name": "string",
* "houseNo": "string",
* "street": "string",
* "province": "string",
* "city": "string",
* "postCode": "string",
* "countryCode": "string",
* "firstName": "string",
* "middleName": "string",
* "lastName": "string",
* "generation": "string",
* "dateOfBirth": "string",
* "nationalId": "string",
* "citizenship": "string",
* "phoneNo": "string"
},
* "scheduleId": "string",
* "scheduledOn": "2019-08-24T14:15:22Z",
* "profileId": "string",
* "profileName": "string",
* "alertCreatedAt": "2019-08-24T14:15:22Z",
* "alertsCount": 0
},
* "frequency": "Daily",
* "screeningThreshold": 0,
* "createdAt": "2019-08-24T14:15:22Z",
* "lastRun": "2019-08-24T14:15:22Z"
}
RETRIEVE SCHEDULE BY ID
get/protect/schedules/{scheduleId}
https://connect.creditsafe.com/v1/protect/schedules/{scheduleId}
https://connect.sandbox.creditsafe.com/v1/protect/schedules/{scheduleId}
Endpoint to retrieve a specific Schedule by Id. A Schedule Id can be retrieved
from the associated Investigation.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
scheduleId
required
string
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
404
RESPONSE SAMPLES
* 200
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "id": "string",
* "customerId": 0,
* "userId": 0,
* "investigationId": "string",
* "investigation": {
* "id": "string",
* "createdAt": "2019-08-24T14:15:22Z",
* "userId": 0,
* "customerId": 0,
* "query": {
* "type": "Business",
* "name": "string",
* "houseNo": "string",
* "street": "string",
* "province": "string",
* "city": "string",
* "postCode": "string",
* "countryCode": "string",
* "firstName": "string",
* "middleName": "string",
* "lastName": "string",
* "generation": "string",
* "dateOfBirth": "string",
* "nationalId": "string",
* "citizenship": "string",
* "phoneNo": "string"
},
* "scheduleId": "string",
* "scheduledOn": "2019-08-24T14:15:22Z",
* "profileId": "string",
* "profileName": "string",
* "alertCreatedAt": "2019-08-24T14:15:22Z",
* "alertsCount": 0
},
* "frequency": "Daily",
* "screeningThreshold": 0,
* "createdAt": "2019-08-24T14:15:22Z",
* "lastRun": "2019-08-24T14:15:22Z"
}
DELETES A SCHEDULE FROM AN INVESTIGATION MEANING E
delete/protect/schedules/{scheduleId}
https://connect.creditsafe.com/v1/protect/schedules/{scheduleId}
https://connect.sandbox.creditsafe.com/v1/protect/schedules/{scheduleId}
Deletes a Schedule from an Investigation meaning entity will no longer be
monitored on a nightly basis but record will still remain in the audit trail
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
scheduleId
required
string
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
204
404
RESPONSE SAMPLES
* 404
Content type
application/json
Copy
Expand all Collapse all
{
* "type": "string",
* "title": "string",
* "status": 0,
* "detail": "string",
* "instance": "string",
* "extensions": {
* "property1": { },
* "property2": { }
}
}
RETRIEVE PROTECT AUDIT LOG
get/protect/audits
https://connect.creditsafe.com/v1/protect/audits
https://connect.sandbox.creditsafe.com/v1/protect/audits
Returns logged interactions with Protect endpoints for audit purposes. Actions
logged include creating an Investigation, Investigation Record and Schedule.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
page
integer
Default: 1
Starting page number.
pageSize
integer
Number of items to return per Page.
type
string or null
Enum: "alert.accepted" "alert.rejected" "alert.received" "profile.added"
"profile.created" "investigation.accepted" "investigation.created"
"investigation.file_downloaded" "schedule.created" "schedule.removed"
newerThan
string or null <date-time>
olderThan
string or null <date-time>
profileId
string or null <guid>
order
string
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "id": "string",
* "description": "string",
* "type": "string",
* "userId": "string",
* "payload": {
* "property1": { },
* "property2": { }
},
* "createdAt": "2019-08-24T14:15:22Z"
}
]
EXPORT AUDIT LOG FILE
post/protect/audits/file
https://connect.creditsafe.com/v1/protect/audits/file
https://connect.sandbox.creditsafe.com/v1/protect/audits/file
Produces a collection a csv of Audit records.
AUTHORIZATIONS:
bearerToken
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
fileType
required
string
Value: "csv"
auditType
string
Enum: "alert.accepted" "alert.rejected" "alert.received" "profile.added"
"profile.created" "investigation.accepted" "investigation.created"
"investigation.file_downloaded" "schedule.created" "schedule.removed"
keywordSearch
string
createdAtOrAfter
string <date-time>
createdAtOrBefore
string <date-time>
payload
object (Connect.Protect.AuditExportPayloadDto)
RESPONSES
200
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "fileType": "csv",
* "auditType": "alert.accepted",
* "keywordSearch": "string",
* "createdAtOrAfter": "2019-08-24T14:15:22Z",
* "createdAtOrBefore": "2019-08-24T14:15:22Z",
* "payload": {
* "profileId": "string",
* "investigationId": "string"
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "location": "http://example.com"
}
LOCAL SOLUTIONS
A toolbox of country-specific functionality. See the description under each
endpoint for more information on a particular solution.
BANK MATCH
get/localSolutions/GB/bankmatch
https://connect.creditsafe.com/v1/localSolutions/GB/bankmatch
https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/bankmatch
The Bank Verification tool allows customers to instantly verify that small and
medium sized companies you are working with are providing correct bank details,
to reduce fraud and avoid delays in your on boarding process. The bank data for
these companies is provided to Creditsafe by various financial providers,
including major banks. When you provide us with a company number and their bank
details, we are able to perform instant checks to verify that those bank details
are associated with that company and return -
Match – We have bank information on the company, and the data provided by the
customer matches the company records
No Match – We have bank information on the company, but the data provided does
not match any of the company records
Data Unavailable - We do not have bank information on the company.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
checkType
required
any
Enum: "Both" "Validate" "Verify"
Validation uses an algorithm to determine if a SCAN or IBAN exists, but does not
let you know if that SCAN or IBAN actually belongs to the company who has
provided it. Verification takes this a step further and checks the Creditsafe
database for a match on the SCAN/IBAN, and tells you if the bank details
actually belong to the company, so you can be assured that you are sending your
money to the correct entity.
companyId
required
string
Example: companyId=GB-0-X9999999
The connectId or safeNumber of the company to check against.
sortCode
string
Example: sortCode=089997
Sort Code to check - Must be passed in with Account Number to form a SCAN Result
accountNumber
string
Example: accountNumber=66374958
Account Number to check - Must be passed in with Sort Code to form a SCAN Result
iban
string
Example: iban=GB55TEST08999966374957
IBAN to check
vatNumber
string
VAT Number to check
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
Indicates the check has been made successfully and contains the result of the
Verification/Validation. A 200 response alone does not immediately indicate the
bank account is valid, only that the check was made in the correct format. Check
the SCAN text and IBAN text fields for the result of the Check.
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "totalSize": 1,
* "bankMatchResults": [
* {
* "companyNumber": "X9999999",
* "accountNumber": "66374957",
* "iban": "GB55TEST08999966374957",
* "ibanResult": "string",
* "ibanText": "The IBAN provided does not match the company UK07499628.",
* "logDate": "2020-06-04T11:04:32.7301608+00:00",
* "safeNumber": "UK07499628",
* "scanResult": "string",
* "scanText": "The Sort Code and Account Number provided does not match
the company UK07499628.",
* "sortCode": "089999",
* "statusResult": "string",
* "statusText": "string",
* "vatResult": "string",
* "vatText": "The VAT provided matches the company UK07499628."
}
]
}
RETRIEVES CCDS DATA
get/localSolutions/GB/CCDS/{companyId}
https://connect.creditsafe.com/v1/localSolutions/GB/CCDS/{companyId}
https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/CCDS/{companyId}
Gets CCDS data of the supplied company
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
companyId
required
string
Example: GB-0-X9999999
The connectId or safeNumber of the company
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "safeNumber": "string",
* "ccdsCompany": {
* "creditSafeCompanyId": "string"
},
* "overallAggregations": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
},
* "bankData": {
* "aggregations": {
* "totalCreditCards": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
},
* "totalCurrentAccounts": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
},
* "totalLoans": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
},
* "perOrganisationAggregations": [
* {
* "providerId": "string",
* "creditCards": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
},
* "currentAccounts": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
},
* "loans": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
}
}
]
},
* "facilities": [
* {
* "businessTypeIndicator": "string",
* "businessName": "string",
* "businessAddress": {
* "line1": "string",
* "line2": "string",
* "line3": "string",
* "line4": "string",
* "line5": "string",
* "line6": "string",
* "postcode": "string"
},
* "additionalTradingStyle": "string",
* "businessTelephoneNumber": "string",
* "companyRegistrationNumber": "string",
* "vatNumber": "string",
* "specialInstructionIndicator": "string",
* "startDateOfAgreement": "2019-08-24T14:15:22Z",
* "closeDateOfAgreement": { },
* "currentBalance": 0,
* "currentBalanceCreditIndicator": "string",
* "actualCurrentBalance": 0,
* "facilityStatus": "string",
* "originalDefaultBalance": 0,
* "defaultSatisfactionDate": { },
* "creditOrOverdraftLimit": 0,
* "flagSettings": "string",
* "transferredToConsolidatedDebtAccount": "string",
* "repaymentPeriod": 0,
* "paymentAmount": 0,
* "paymentFrequencyIndicator": "string",
* "numberOfCashAdvances": 0,
* "valueOfCashAdvances": 0,
* "minimumBalance": 0,
* "minimumBalanceCreditIndicator": "string",
* "actualMinimumBalance": 0,
* "maximumBalance": 0,
* "maximumBalanceCreditIndicator": "string",
* "actualMaximumBalance": 0,
* "averageBalance": 0,
* "averageBalanceCreditIndicator": "string",
* "actualAverageBalance": 0,
* "creditTurnover": 0,
* "creditTurnoverNetOrGrossIndicator": "string",
* "debitTurnover": 0,
* "debitTurnoverNetOrGrossIndicator": "string",
* "rejectedPayments": 0,
* "maximumDurationOfExcess": 0,
* "changedFacilityNumber": "string",
* "bankSortCode": "string",
* "bankAccountNumber": "string",
* "bankAccountIban": "string",
* "currentAccountReportingLevelIndicator": "string",
* "sourceCode": "string",
* "facilityNumber": "string",
* "facilityId": "string",
* "identifier": "string",
* "providerType": "string",
* "bankCode": "string",
* "batch": "string",
* "facilityType": 0,
* "facilityTypeCategory": "string"
}
]
},
* "afpData": {
* "aggregations": {
* "totalCreditCards": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
},
* "totalCurrentAccounts": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
},
* "totalLoans": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
},
* "perOrganisationAggregations": [
* {
* "providerId": "string",
* "creditCards": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
},
* "currentAccounts": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
},
* "loans": {
* "totalAccounts": 0,
* "totalBalance": 0,
* "totalOverdraftOrCreditLimit": 0,
* "remainingBalance": 0,
* "totalAverageBalance": 0
}
}
]
},
* "facilities": [
* {
* "businessTypeIndicator": "string",
* "businessName": "string",
* "businessAddress": {
* "line1": "string",
* "line2": "string",
* "line3": "string",
* "line4": "string",
* "line5": "string",
* "line6": "string",
* "postcode": "string"
},
* "additionalTradingStyle": "string",
* "businessTelephoneNumber": "string",
* "companyRegistrationNumber": "string",
* "vatNumber": "string",
* "specialInstructionIndicator": "string",
* "startDateOfAgreement": "2019-08-24T14:15:22Z",
* "closeDateOfAgreement": { },
* "currentBalance": 0,
* "currentBalanceCreditIndicator": "string",
* "actualCurrentBalance": 0,
* "facilityStatus": "string",
* "originalDefaultBalance": 0,
* "defaultSatisfactionDate": { },
* "creditOrOverdraftLimit": 0,
* "flagSettings": "string",
* "transferredToConsolidatedDebtAccount": "string",
* "repaymentPeriod": 0,
* "paymentAmount": 0,
* "paymentFrequencyIndicator": "string",
* "numberOfCashAdvances": 0,
* "valueOfCashAdvances": 0,
* "minimumBalance": 0,
* "minimumBalanceCreditIndicator": "string",
* "actualMinimumBalance": 0,
* "maximumBalance": 0,
* "maximumBalanceCreditIndicator": "string",
* "actualMaximumBalance": 0,
* "averageBalance": 0,
* "averageBalanceCreditIndicator": "string",
* "actualAverageBalance": 0,
* "creditTurnover": 0,
* "creditTurnoverNetOrGrossIndicator": "string",
* "debitTurnover": 0,
* "debitTurnoverNetOrGrossIndicator": "string",
* "rejectedPayments": 0,
* "maximumDurationOfExcess": 0,
* "changedFacilityNumber": "string",
* "bankSortCode": "string",
* "bankAccountNumber": "string",
* "bankAccountIban": "string",
* "currentAccountReportingLevelIndicator": "string",
* "sourceCode": "string",
* "facilityNumber": "string",
* "facilityId": "string",
* "identifier": "string",
* "providerType": "string",
* "bankCode": "string",
* "batch": "string",
* "facilityType": 0,
* "facilityTypeCategory": "string"
}
]
}
}
GB CONSUMERS AND AML
The identity service endpoints are used to run GB Consumer and AML searches. You
must specify the product type and search parameters you want to obtain a
response for in the body of the request.
SUBMITS A GB CONSUMER OR AML SEARCH
post/localSolutions/GB/identitysearch
https://connect.creditsafe.com/v1/localSolutions/GB/identitysearch
https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch
Submits a GB Consumer or AML depending on the Product provided. Validates
criteria for each individual search before submitting, and may return a list of
error strings instead.
AUTHORIZATIONS:
bearerToken
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
Select the products tab for the request body for each of the products AML and
Consumer
One of
AMLSearchconsumerSearch
UniqueId
string or null
common
object
Person search criteria
consumer
object (Connect.Identity.ConsumerSearchCriteria)
iDAml
object
Reference to bank account detail search
products
string
Enter AML for this product search
RESPONSES
200
Success
400
Bad Request
401
Invalid Token
403
Access Forbidden
500
Server Error
REQUEST SAMPLES
* Payload
Content type
application/json
Example
AMLSearchconsumerSearchAMLSearch
Copy
Expand all Collapse all
{
* "common": {
* "person": {
* "currentName": {
* "title": "MR",
* "forename": "John",
* "otherNames": "",
* "surname": "Murphy",
* "suffix": ""
},
* "dateOfBirth": "1974-07-07",
* "gender": "",
* "addresses": {
* "current": {
* "buildingNo": "",
* "buildingName": "Stadium Plaza",
* "street": "Wood Street",
* "city": "Cardiff",
* "postCode": "CF10 1LA"
}
}
},
* "reference": ""
},
* "idAml": {
* "landlineNumber": "",
* "exDirectory": false,
* "sortCode": "",
* "bankAccountNumber": ""
},
* "products": [
* "Aml"
]
}
RESPONSE SAMPLES
* 200
* 400
* 401
* 403
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "input": {
* "uniqueId": "string",
* "common": {
* "person": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "customerId": 0,
* "userId": 0,
* "reference": "string",
* "isInternal": true
},
* "consumer": {
* "secondPerson": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "balanceOrLimit": 0,
* "transient": true,
* "creditType": "string",
* "term": "string",
* "reason": 0,
* "thirdPartyOptIn": true,
* "originalSearchRef": "string",
* "addressLink": true,
* "associateLink": true,
* "resolvedPicklist": [
* "string"
],
* "cachedPicklist": { },
* "isSubsequent": true
},
* "idAml": {
* "landlineNumber": "string",
* "exDirectory": true,
* "sortCode": "string",
* "bankAccountNumber": "string"
},
* "products": [
* 0
]
},
* "common": {
* "customerId": 0,
* "userId": 0,
* "uniqueId": "string",
* "searchText": "string",
* "reference": "string",
* "searchTime": "2019-08-24T14:15:22Z"
},
* "consumer": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "id": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "aml": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "bankMatch": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "picklist": [
* {
* "type": "string",
* "applicantId": 0,
* "address": "string",
* "name": "string",
* "inputs": {
* "name": "string",
* "address": "string"
},
* "options": [
* {
* "option": "string",
* "value": "string"
}
]
}
],
* "message": "string",
* "errors": {
* "property1": [
* "string"
],
* "property2": [
* "string"
]
}
}
RESOLVES A PICKLIST AGAINST A GIVEN UNIQUEID
put/localSolutions/GB/identitysearch
https://connect.creditsafe.com/v1/localSolutions/GB/identitysearch
https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch
Resolves a picklist belonging to the specified UniqueID, which would have been
generated during a prior search. Guids (and thus cached searches) expire after
fifteen minutes.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
resolved
Array of strings or null
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
object
RESPONSES
200
Success
400
Bad Request
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{ }
RESPONSE SAMPLES
* 200
* 400
Content type
application/json
Copy
Expand all Collapse all
{
* "input": {
* "uniqueId": "string",
* "common": {
* "person": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "customerId": 0,
* "userId": 0,
* "reference": "string",
* "isInternal": true
},
* "consumer": {
* "secondPerson": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "balanceOrLimit": 0,
* "transient": true,
* "creditType": "string",
* "term": "string",
* "reason": 0,
* "thirdPartyOptIn": true,
* "originalSearchRef": "string",
* "addressLink": true,
* "associateLink": true,
* "resolvedPicklist": [
* "string"
],
* "cachedPicklist": { },
* "isSubsequent": true
},
* "idAml": {
* "landlineNumber": "string",
* "exDirectory": true,
* "sortCode": "string",
* "bankAccountNumber": "string"
},
* "products": [
* 0
]
},
* "common": {
* "customerId": 0,
* "userId": 0,
* "uniqueId": "string",
* "searchText": "string",
* "reference": "string",
* "searchTime": "2019-08-24T14:15:22Z"
},
* "consumer": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "id": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "aml": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "bankMatch": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "picklist": [
* {
* "type": "string",
* "applicantId": 0,
* "address": "string",
* "name": "string",
* "inputs": {
* "name": "string",
* "address": "string"
},
* "options": [
* {
* "option": "string",
* "value": "string"
}
]
}
],
* "message": "string",
* "errors": {
* "property1": [
* "string"
],
* "property2": [
* "string"
]
}
}
RETRIEVES A PRIOR IDENTITYSEARCH'S INPUT
get/localSolutions/GB/identitysearch/history/{uniqueId}/input
https://connect.creditsafe.com/v1/localSolutions/GB/identitysearch/history/{uniqueId}/input
https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch/history/{uniqueId}/input
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
uniqueId
required
string
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
Success
400
Bad Request
RESPONSE SAMPLES
* 200
* 400
Content type
application/json
Copy
Expand all Collapse all
{
* "input": {
* "uniqueId": "string",
* "common": {
* "person": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "customerId": 0,
* "userId": 0,
* "reference": "string",
* "isInternal": true
},
* "consumer": {
* "secondPerson": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "balanceOrLimit": 0,
* "transient": true,
* "creditType": "string",
* "term": "string",
* "reason": 0,
* "thirdPartyOptIn": true,
* "originalSearchRef": "string",
* "addressLink": true,
* "associateLink": true,
* "resolvedPicklist": [
* "string"
],
* "cachedPicklist": { },
* "isSubsequent": true
},
* "idAml": {
* "landlineNumber": "string",
* "exDirectory": true,
* "sortCode": "string",
* "bankAccountNumber": "string"
},
* "products": [
* 0
]
},
* "common": {
* "customerId": 0,
* "userId": 0,
* "uniqueId": "string",
* "searchText": "string",
* "reference": "string",
* "searchTime": "2019-08-24T14:15:22Z"
},
* "consumer": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "id": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "aml": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "bankMatch": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "picklist": [
* {
* "type": "string",
* "applicantId": 0,
* "address": "string",
* "name": "string",
* "inputs": {
* "name": "string",
* "address": "string"
},
* "options": [
* {
* "option": "string",
* "value": "string"
}
]
}
],
* "message": "string",
* "errors": {
* "property1": [
* "string"
],
* "property2": [
* "string"
]
}
}
RETRIEVES A PRIOR IDENTITYSEARCH RESULT.
get/localSolutions/GB/identitysearch/history/{uniqueId}
https://connect.creditsafe.com/v1/localSolutions/GB/identitysearch/history/{uniqueId}
https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch/history/{uniqueId}
Retrieves a prior search result. This will include the search input and any
ID/AML searches, but as we cannot hold Consumer search results these are not
included. Resubmission is necessary if an updated Consumer result is needed.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
uniqueId
required
string
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
Success
400
Bad Request
RESPONSE SAMPLES
* 200
* 400
Content type
application/json
Copy
Expand all Collapse all
{
* "input": {
* "uniqueId": "string",
* "common": {
* "person": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "customerId": 0,
* "userId": 0,
* "reference": "string",
* "isInternal": true
},
* "consumer": {
* "secondPerson": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "balanceOrLimit": 0,
* "transient": true,
* "creditType": "string",
* "term": "string",
* "reason": 0,
* "thirdPartyOptIn": true,
* "originalSearchRef": "string",
* "addressLink": true,
* "associateLink": true,
* "resolvedPicklist": [
* "string"
],
* "cachedPicklist": { },
* "isSubsequent": true
},
* "idAml": {
* "landlineNumber": "string",
* "exDirectory": true,
* "sortCode": "string",
* "bankAccountNumber": "string"
},
* "products": [
* 0
]
},
* "common": {
* "customerId": 0,
* "userId": 0,
* "uniqueId": "string",
* "searchText": "string",
* "reference": "string",
* "searchTime": "2019-08-24T14:15:22Z"
},
* "consumer": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "id": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "aml": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "bankMatch": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "picklist": [
* {
* "type": "string",
* "applicantId": 0,
* "address": "string",
* "name": "string",
* "inputs": {
* "name": "string",
* "address": "string"
},
* "options": [
* {
* "option": "string",
* "value": "string"
}
]
}
],
* "message": "string",
* "errors": {
* "property1": [
* "string"
],
* "property2": [
* "string"
]
}
}
GETS IDENTITYSEARCH REASONS.
get/localSolutions/GB/identitysearch/searchreasons
https://connect.creditsafe.com/v1/localSolutions/GB/identitysearch/searchreasons
https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch/searchreasons
Returns an object describing which Reasons for Search are available and which
are selected by a given customer. All reasons are always listed, with selected
reasons specified as true.
AUTHORIZATIONS:
bearerToken
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
Success
400
Bad Request
RESPONSE SAMPLES
* 200
* 400
Content type
application/json
Copy
Expand all Collapse all
{
* "data": {
* "property1": true,
* "property2": true
},
* "message": "string",
* "errors": {
* "property1": [
* "string"
],
* "property2": [
* "string"
]
}
}
GETS A LIST OF IDENTITYSEARCH HISTORY ITEMS
get/localSolutions/GB/identitysearch/history
https://connect.creditsafe.com/v1/localSolutions/GB/identitysearch/history
https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch/history
Retrieves a paginated history list for the specified customer/user, filtered
based on the include* parameters
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
page
integer or null <int32>
The 1-indexed page number to fetch
pageSize
integer or null <int32>
The page size number to fetch
IncludeCustomer
boolean
If true, returns all results for this customer. Valid for senior users only.
Products
Array of integers or null <int32> (Connect.Identity.Product)
Enum: 0 1 2 3 4
The array of products to include
Below is a list of Definitions for the ENUM
* 0 - Consumer
* 1 - Id
* 2 - AML
* 3 - Bank Match
* 4 - AML with Bank Match
DateFrom
string or null <date-time>
The earliest date to include
DateTo
string or null <date-time>
The latest date to include
Keyword
string or null
Include this string
Result
string or null
Return only items with this result
RESPONSES
200
Success
400
Bad Request
RESPONSE SAMPLES
* 200
* 400
Content type
application/json
Copy
Expand all Collapse all
{
* "totalCount": 0,
* "data": [
* {
* "uniqueId": "string",
* "customerId": 0,
* "userId": 0,
* "searchTime": "2019-08-24T14:15:22Z",
* "searchText": "string",
* "reference": "string",
* "hasConsumerInt": 0,
* "hasConsumer": true,
* "hasIdInt": 0,
* "hasId": true,
* "hasAmlInt": 0,
* "hasAml": true,
* "hasBankMatchInt": 0,
* "hasBankMatch": true,
* "hasAmlWithBankMatchInt": 0,
* "hasAmlWithBankMatch": true,
* "consumerId": "string",
* "consumerOriginalId": "string",
* "consumerBand1": 0,
* "consumerScore1": 0,
* "consumerBand2": 0,
* "consumerScore2": 0,
* "gaugeVersion": "string",
* "consumerReason": "string",
* "linkedReport": "string",
* "idId": "string",
* "idAuthenticationId": "string",
* "idChainId": "string",
* "idValidationId": "string",
* "idLegacyID": "string",
* "idResult": 0,
* "idHasAlertsInt": 0,
* "idHasAlerts": true,
* "amlType": 0,
* "amlId": "string",
* "amlAuthenticationId": "string",
* "amlChainId": "string",
* "amlValidationId": "string",
* "amlLegacyID": "string",
* "amlResult": 0,
* "amlHasAlertsInt": 0,
* "amlHasAlerts": true,
* "idRevalidatedInt": 0,
* "idHasRevalidated": true,
* "idCanRevalidate": true,
* "amlRevalidatedInt": 0,
* "amlHasRevalidated": true,
* "amlCanRevalidate": true,
* "input": {
* "uniqueId": "string",
* "common": {
* "person": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "customerId": 0,
* "userId": 0,
* "reference": "string",
* "isInternal": true
},
* "consumer": {
* "secondPerson": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "balanceOrLimit": 0,
* "transient": true,
* "creditType": "string",
* "term": "string",
* "reason": 0,
* "thirdPartyOptIn": true,
* "originalSearchRef": "string",
* "addressLink": true,
* "associateLink": true,
* "resolvedPicklist": [
* "string"
],
* "cachedPicklist": { },
* "isSubsequent": true
},
* "idAml": {
* "landlineNumber": "string",
* "exDirectory": true,
* "sortCode": "string",
* "bankAccountNumber": "string"
},
* "products": [
* 0
]
},
* "consumer": {
* "applicant1Report": {
* "reportTitle": "string",
* "reportType": "string",
* "summary": {
* "name": "string",
* "matchedData": [
* {
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "name": "string",
* "addressLine1": "string",
* "addressLine2": "string",
* "addressLine3": "string",
* "addressLine4": "string",
* "isSelected": true
}
],
* "matchLevel": "string",
* "noticesOfCorrections": true,
* "totalDisputes": 0,
* "confirmedAddress": "string",
* "residency": [
* {
* "address": "string",
* "currentAddress": true,
* "id": 0,
* "message": "string",
* "undeclaredAddressType": 0
}
],
* "creditSearchesAtCurrentAddress": {
* "numberInLast3Months": 0,
* "numberInLast12Months": 0,
* "totalInLast3Months": 0
},
* "insolvencyAtAddress": {
* "restricted": true,
* "currentlyInsolvent": true,
* "totalDischarged": 0
},
* "links": {
* "undeclaredAddressCount": 0,
* "undeclaredAliasCount": 0,
* "undeclaredAssociatesCount": 0,
* "undeclaredAddressSearchedCount": 0,
* "undeclaredAddressUnsearchedCount": 0
},
* "judgements": {
* "total": 0,
* "total3Years": 0,
* "totalActive": 0,
* "totalSatisfied": 0,
* "totalActiveAmount": 0,
* "totalSatisfiedAmount": 0
},
* "totalCifas": 0,
* "rtr": true,
* "share": {
* "accountCount": 0,
* "activeAccountCount": 0,
* "settledAccountCount": 0,
* "accountsOpenedInLast6MonthsCount": 0,
* "delinquentAccountsInLast12MonthsCount": 0,
* "worstPaymentStatusInLast12MonthsCount": "string",
* "worstPaymentStatusInLast36MonthsCount": "string",
* "defaultsInLast12MonthsCount": 0,
* "defaultsInLast36MonthsCount": 0
},
* "behaviouralData": {
* "minPayments12Months": 0,
* "minPayments36Months": 0,
* "cashAdvanceValue12Months": 0,
* "cashAdvanceValue36Months": 0
},
* "impairedCreditHistory": {
* "impairedCredit": true,
* "secured": true,
* "unsecured": true,
* "judgement": true,
* "individualVoluntaryAgreement": true,
* "bankruptcy": true
},
* "thirdParty": {
* "alertDecision": 0,
* "alertReview": 0,
* "householdOverride": 0
},
* "address": {
* "paf": true,
* "rollingRoll": true,
* "message": "string"
},
* "inDebt": {
* "totalActiveBalance": 0,
* "totalBalance": 0,
* "balanceLimitRatio": 0,
* "totalLimit": 0,
* "totalLoanBalance": 0,
* "totalMortgageBalance": 0
},
* "cardData": {
* "totalMinPayments12Months": 0,
* "totalMinPayments36Months": 0,
* "totalCashAdvance12Months": 0,
* "totalCashAdvance36Months": 0
}
},
* "score": {
* "band": 0,
* "version": "string",
* "score": 0
},
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": "string",
* "name": "string",
* "duration": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z",
* "electoralRollValid": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": "2019-08-24T14:15:22Z",
* "optOut": true,
* "rollingRoll": true,
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "undeclaredAddressType": "string"
},
* "previousAddress1": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": "string",
* "name": "string",
* "duration": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z",
* "electoralRollValid": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": "2019-08-24T14:15:22Z",
* "optOut": true,
* "rollingRoll": true,
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "undeclaredAddressType": "string"
},
* "previousAddress2": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": "string",
* "name": "string",
* "duration": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z",
* "electoralRollValid": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": "2019-08-24T14:15:22Z",
* "optOut": true,
* "rollingRoll": true,
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "undeclaredAddressType": "string"
},
* "links": {
* "undeclaredAddresses": [
* {
* "undeclaredAddress": "string",
* "undeclaredAddressTo": "string",
* "source": "string",
* "lastConfirmation": "string",
* "earliestConfirmation": "string",
* "navigationLinkIdentifier": "string",
* "navigationLinkIdentifierTo": "string",
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "aliases": [
* {
* "declared": true,
* "name": "string",
* "alias": "string",
* "source": "string",
* "sourceType": "string",
* "creationDate": "2019-08-24T14:15:22Z",
* "lastConfirmation": "2019-08-24T14:15:22Z",
* "supplierDetails": {
* "supplierName": "string",
* "supplierType": "string"
},
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "associates": [
* {
* "navigationLinkId": "string",
* "name": "string",
* "creationDate": "2019-08-24T14:15:22Z",
* "lastConfirmation": "2019-08-24T14:15:22Z",
* "supplierDetails": {
* "supplierName": "string",
* "supplierType": "string"
},
* "declared": true,
* "associateId": 0,
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "notices": [
* {
* "name": "string",
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* null
],
* "otherResidents": true,
* "electoralRollHistory": [
* null
],
* "undeclaredAddressType": "string"
},
* "reference": "string",
* "comment": "string",
* "type": "string",
* "dateRaised": "2019-08-24T14:15:22Z"
}
]
},
* "cifas": { },
* "rtr": [
* { }
],
* "insolvencies": [
* {
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": null,
* "name": null,
* "duration": null,
* "startDate": null,
* "endDate": null,
* "electoralRollValid": null,
* "electoralRollHistory": [ ],
* "notices": [ ]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "undeclaredAddressType": "string"
},
* "companyName": "string",
* "court": "string",
* "dischargeDate": "2019-08-24T14:15:22Z",
* "name": "string",
* "orderDate": "2019-08-24T14:15:22Z",
* "orderType": "string",
* "status": "string",
* "tradingName": "string",
* "lineOfBusiness": "string",
* "amount": 0,
* "caseYear": 0,
* "caseRef": "string",
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "notices": [
* {
* "name": "string",
* "address": {
* "address": null,
* "isCurrent": null,
* "isPaf": null,
* "residents": [ ],
* "otherResidents": null,
* "electoralRollHistory": [ ],
* "undeclaredAddressType": null
},
* "reference": "string",
* "comment": "string",
* "type": "string",
* "dateRaised": "2019-08-24T14:15:22Z"
}
],
* "restriction": {
* "type": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
],
* "judgements": [
* {
* "name": "string",
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": null,
* "name": null,
* "duration": null,
* "startDate": null,
* "endDate": null,
* "electoralRollValid": null,
* "electoralRollHistory": [ ],
* "notices": [ ]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "undeclaredAddressType": "string"
},
* "addressCurrent": true,
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "judgementDate": "2019-08-24T14:15:22Z",
* "amount": 0,
* "status": "string",
* "court": "string",
* "courtType": "string",
* "caseNumber": "string",
* "satifiedDate": "2019-08-24T14:15:22Z",
* "notices": [
* {
* "name": "string",
* "address": {
* "address": null,
* "isCurrent": null,
* "isPaf": null,
* "residents": [ ],
* "otherResidents": null,
* "electoralRollHistory": [ ],
* "undeclaredAddressType": null
},
* "reference": "string",
* "comment": "string",
* "type": "string",
* "dateRaised": "2019-08-24T14:15:22Z"
}
]
}
],
* "history": [
* {
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": null,
* "name": null,
* "duration": null,
* "startDate": null,
* "endDate": null,
* "electoralRollValid": null,
* "electoralRollHistory": [ ],
* "notices": [ ]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "undeclaredAddressType": "string"
},
* "addressMatch": "string",
* "balance": 0,
* "date": "2019-08-24T14:15:22Z",
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z",
* "jointApplication": true,
* "linkType": "string",
* "name": "string",
* "tpOptIn": true,
* "organisationName": "string",
* "organisationType": "string",
* "ownSearch": true,
* "purpose": "string",
* "reason": "string",
* "reference": "string",
* "supplierReference": "string",
* "subsequentEnquiry": true,
* "term": 0,
* "transient": true,
* "creditType": "string",
* "unitName": "string",
* "userName": "string",
* "searchDate": "2019-08-24T14:15:22Z",
* "searchUnitName": "string",
* "searchOrganisationName": "string",
* "searchOrganisationType": "string"
}
],
* "notices": [
* {
* "name": "string",
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": null,
* "name": null,
* "duration": null,
* "startDate": null,
* "endDate": null,
* "electoralRollValid": null,
* "electoralRollHistory": [ ],
* "notices": [ ]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "undeclaredAddressType": "string"
},
* "reference": "string",
* "comment": "string",
* "type": "string",
* "dateRaised": "2019-08-24T14:15:22Z"
}
],
* "demographics": {
* "cameoCode": "string",
* "cameoInvestorCode": "string",
* "cameoIncomeCode": "string",
* "cameoUnemploymentCode": "string",
* "cameoPropertyCode": "string",
* "cameoFinanceCode": "string",
* "cameoFinanceGroup": "string",
* "cameoIncomeGroup": "string",
* "cameoInvestmentGroup": "string",
* "cameoGroup": "string",
* "familyComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "ageComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "economicComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "economicActivityComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "hasValues": true,
* "houseTypeComposition": [
* {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
}
],
* "householdComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "lifestageComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "mortgageComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "neighbourhoodDefinition": {
* "financeGroup": "string",
* "financeGroupHouseholdPerc": "string",
* "income": "string",
* "incomeGroup": "string",
* "investorHouseholdPerc": "string",
* "investorIndex": "string",
* "riskFactor": "string",
* "uk": "string",
* "ukGroup": "string",
* "ukHouseholdPerc": "string",
* "description": "string"
},
* "occupationComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "propertyComposition": {
* "averageDetachedPropertyValue": "string",
* "averageDetachedPropertyValueDescription": "string",
* "averageFlatPropertyValue": "string",
* "averageFlatPropertyValueDescriptionField": "string",
* "averageHouseAge": "string",
* "averageSemiDetachedPropertyValue": "string",
* "averageSemiDetachedPropertyValueDescription": "string",
* "averageTerracePropertyValue": "string",
* "averageTerracePropertyValueDescription": "string",
* "councilTaxBand": "string",
* "councilTaxBandDescription": "string",
* "householdDensity": "string",
* "locationType": "string",
* "nationalAverageHousePrice": "string",
* "nationalAverageHousePriceAboveOrBelow": "string",
* "nationalAverageHousePriceDifference": "string",
* "averageFlatPropertyValueDescription": "string"
},
* "shareholderComposition": {
* "averageInvestments": "string",
* "averageInvestmentsDescription": "string",
* "averageInvestmentsLabel": "string",
* "averageShareholders": "string",
* "averageShareholdersDescription": "string",
* "averageShareholdersLabel": "string",
* "averageShares": "string",
* "averageSharesDescription": "string",
* "averageSharesLabel": "string",
* "averageValue": "string",
* "averageValueDescription": "string",
* "averageValueLabel": "string",
* "proportionOfHouseholdsWithShares": "string",
* "proportionOfHouseholdsWithSharesDescription": "string",
* "proportionOfHouseholdsWithSharesLabel": "string"
},
* "socialClassComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "tenureComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "unemploymentComposition": {
* "maleLongTermUnemployment": "string",
* "maleLongTermUnemploymentDescription": "string",
* "maleLongTermUnemploymentLabel": "string",
* "unemploymentAmong18to24YearOlds": "string",
* "unemploymentAmong18to24YearOldsDescription": "string",
* "unemploymentAmong18to24YearOldsLabel": "string",
* "unemploymentAmong25to39YearOlds": "string",
* "unemploymentAmong25to39YearOldsDescription": "string",
* "unemploymentAmong25to39YearOldsLabel": "string",
* "unemploymentAmongThoseAged40andOlder": "string",
* "unemploymentAmongThoseAged40andOlderDescription":
"string",
* "unemploymentAmongThoseAged40andOlderLabel": "string",
* "unemploymentScoreLabel": "string",
* "unemploymentScoreDescription": "string",
* "unemploymentScore": "string",
* "maleLongTermUnemploymentScore": "string"
}
},
* "thirdPartyAlerts": {
* "decision": 0,
* "review": 0,
* "hho": 0
},
* "shareAccounts": [
* {
* "supplierDetails": {
* "behaviouralData": true,
* "supplierName": "string",
* "supplierType": "string"
},
* "history": [
* {
* "yearAndMonth": "string",
* "balance": 0,
* "limit": 0,
* "status": "string",
* "statusDescription": "string",
* "paymentStatus": "string",
* "paymentStatusDescription": "string",
* "statementBalance": 0,
* "paymentAmount": 0,
* "cashAdvanceCount": 0,
* "cashAdvancesTotal": 0
}
],
* "holderDetails": {
* "name": "string",
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* null
],
* "otherResidents": true,
* "electoralRollHistory": [
* null
],
* "undeclaredAddressType": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "status": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "default": {
* "date": "2019-08-24T14:15:22Z",
* "originalBalance": 0,
* "terminationBalance": 0,
* "satisfactionDate": "2019-08-24T14:15:22Z",
* "repossessionDate": "2019-08-24T14:15:22Z"
},
* "delinquency": {
* "date": "2019-08-24T14:15:22Z",
* "balance": 0
},
* "historyBatches": [
* {
* "accountHistory": [
* null
],
* "isFirstBatch": true,
* "isLastBatch": true
}
],
* "details": {
* "accountNumber": "string",
* "accountSuffix": 0,
* "joint": true,
* "status": "string",
* "dateUpdated": "2019-08-24T14:15:22Z",
* "currencyCode": "string",
* "balance": 0,
* "limit": 0,
* "openingBalance": 0,
* "arrangementStartDate": "2019-08-24T14:15:22Z",
* "arrangementEndDate": "2019-08-24T14:15:22Z",
* "paymentStartDate": "2019-08-24T14:15:22Z",
* "accountStartDate": "2019-08-24T14:15:22Z",
* "accountEndDate": "2019-08-24T14:15:22Z",
* "regularPayment": 0,
* "expectedPayment": 0,
* "actualPayment": 0,
* "repaymentPeriod": 0,
* "lumpPayment": 0,
* "penaltyInterestAmount": 0,
* "promotionalRate": true,
* "minimumPayment": true,
* "statementBalance": 0,
* "typeCode": "string",
* "type": "string",
* "groupId": 0,
* "repaymentFrequencyCode": "string",
* "repaymentFrequency": "string"
},
* "notices": [
* {
* "name": "string",
* "address": {
* "address": null,
* "isCurrent": null,
* "isPaf": null,
* "residents": [ ],
* "otherResidents": null,
* "electoralRollHistory": [ ],
* "undeclaredAddressType": null
},
* "reference": "string",
* "comment": "string",
* "type": "string",
* "dateRaised": "2019-08-24T14:15:22Z"
}
]
}
]
},
* "applicant2Report": {
* "reportTitle": "string",
* "reportType": "string",
* "summary": {
* "name": "string",
* "matchedData": [
* {
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "name": "string",
* "addressLine1": "string",
* "addressLine2": "string",
* "addressLine3": "string",
* "addressLine4": "string",
* "isSelected": true
}
],
* "matchLevel": "string",
* "noticesOfCorrections": true,
* "totalDisputes": 0,
* "confirmedAddress": "string",
* "residency": [
* {
* "address": "string",
* "currentAddress": true,
* "id": 0,
* "message": "string",
* "undeclaredAddressType": 0
}
],
* "creditSearchesAtCurrentAddress": {
* "numberInLast3Months": 0,
* "numberInLast12Months": 0,
* "totalInLast3Months": 0
},
* "insolvencyAtAddress": {
* "restricted": true,
* "currentlyInsolvent": true,
* "totalDischarged": 0
},
* "links": {
* "undeclaredAddressCount": 0,
* "undeclaredAliasCount": 0,
* "undeclaredAssociatesCount": 0,
* "undeclaredAddressSearchedCount": 0,
* "undeclaredAddressUnsearchedCount": 0
},
* "judgements": {
* "total": 0,
* "total3Years": 0,
* "totalActive": 0,
* "totalSatisfied": 0,
* "totalActiveAmount": 0,
* "totalSatisfiedAmount": 0
},
* "totalCifas": 0,
* "rtr": true,
* "share": {
* "accountCount": 0,
* "activeAccountCount": 0,
* "settledAccountCount": 0,
* "accountsOpenedInLast6MonthsCount": 0,
* "delinquentAccountsInLast12MonthsCount": 0,
* "worstPaymentStatusInLast12MonthsCount": "string",
* "worstPaymentStatusInLast36MonthsCount": "string",
* "defaultsInLast12MonthsCount": 0,
* "defaultsInLast36MonthsCount": 0
},
* "behaviouralData": {
* "minPayments12Months": 0,
* "minPayments36Months": 0,
* "cashAdvanceValue12Months": 0,
* "cashAdvanceValue36Months": 0
},
* "impairedCreditHistory": {
* "impairedCredit": true,
* "secured": true,
* "unsecured": true,
* "judgement": true,
* "individualVoluntaryAgreement": true,
* "bankruptcy": true
},
* "thirdParty": {
* "alertDecision": 0,
* "alertReview": 0,
* "householdOverride": 0
},
* "address": {
* "paf": true,
* "rollingRoll": true,
* "message": "string"
},
* "inDebt": {
* "totalActiveBalance": 0,
* "totalBalance": 0,
* "balanceLimitRatio": 0,
* "totalLimit": 0,
* "totalLoanBalance": 0,
* "totalMortgageBalance": 0
},
* "cardData": {
* "totalMinPayments12Months": 0,
* "totalMinPayments36Months": 0,
* "totalCashAdvance12Months": 0,
* "totalCashAdvance36Months": 0
}
},
* "score": {
* "band": 0,
* "version": "string",
* "score": 0
},
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": "string",
* "name": "string",
* "duration": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z",
* "electoralRollValid": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": "2019-08-24T14:15:22Z",
* "optOut": true,
* "rollingRoll": true,
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "undeclaredAddressType": "string"
},
* "previousAddress1": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": "string",
* "name": "string",
* "duration": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z",
* "electoralRollValid": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": "2019-08-24T14:15:22Z",
* "optOut": true,
* "rollingRoll": true,
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "undeclaredAddressType": "string"
},
* "previousAddress2": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": "string",
* "name": "string",
* "duration": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z",
* "electoralRollValid": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": "2019-08-24T14:15:22Z",
* "optOut": true,
* "rollingRoll": true,
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "undeclaredAddressType": "string"
},
* "links": {
* "undeclaredAddresses": [
* {
* "undeclaredAddress": "string",
* "undeclaredAddressTo": "string",
* "source": "string",
* "lastConfirmation": "string",
* "earliestConfirmation": "string",
* "navigationLinkIdentifier": "string",
* "navigationLinkIdentifierTo": "string",
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "aliases": [
* {
* "declared": true,
* "name": "string",
* "alias": "string",
* "source": "string",
* "sourceType": "string",
* "creationDate": "2019-08-24T14:15:22Z",
* "lastConfirmation": "2019-08-24T14:15:22Z",
* "supplierDetails": {
* "supplierName": "string",
* "supplierType": "string"
},
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "associates": [
* {
* "navigationLinkId": "string",
* "name": "string",
* "creationDate": "2019-08-24T14:15:22Z",
* "lastConfirmation": "2019-08-24T14:15:22Z",
* "supplierDetails": {
* "supplierName": "string",
* "supplierType": "string"
},
* "declared": true,
* "associateId": 0,
* "notices": [
* {
* "name": null,
* "address": null,
* "reference": null,
* "comment": null,
* "type": null,
* "dateRaised": null
}
]
}
],
* "notices": [
* {
* "name": "string",
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* null
],
* "otherResidents": true,
* "electoralRollHistory": [
* null
],
* "undeclaredAddressType": "string"
},
* "reference": "string",
* "comment": "string",
* "type": "string",
* "dateRaised": "2019-08-24T14:15:22Z"
}
]
},
* "cifas": { },
* "rtr": [
* { }
],
* "insolvencies": [
* {
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": null,
* "name": null,
* "duration": null,
* "startDate": null,
* "endDate": null,
* "electoralRollValid": null,
* "electoralRollHistory": [ ],
* "notices": [ ]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "undeclaredAddressType": "string"
},
* "companyName": "string",
* "court": "string",
* "dischargeDate": "2019-08-24T14:15:22Z",
* "name": "string",
* "orderDate": "2019-08-24T14:15:22Z",
* "orderType": "string",
* "status": "string",
* "tradingName": "string",
* "lineOfBusiness": "string",
* "amount": 0,
* "caseYear": 0,
* "caseRef": "string",
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "notices": [
* {
* "name": "string",
* "address": {
* "address": null,
* "isCurrent": null,
* "isPaf": null,
* "residents": [ ],
* "otherResidents": null,
* "electoralRollHistory": [ ],
* "undeclaredAddressType": null
},
* "reference": "string",
* "comment": "string",
* "type": "string",
* "dateRaised": "2019-08-24T14:15:22Z"
}
],
* "restriction": {
* "type": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
],
* "judgements": [
* {
* "name": "string",
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": null,
* "name": null,
* "duration": null,
* "startDate": null,
* "endDate": null,
* "electoralRollValid": null,
* "electoralRollHistory": [ ],
* "notices": [ ]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "undeclaredAddressType": "string"
},
* "addressCurrent": true,
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "judgementDate": "2019-08-24T14:15:22Z",
* "amount": 0,
* "status": "string",
* "court": "string",
* "courtType": "string",
* "caseNumber": "string",
* "satifiedDate": "2019-08-24T14:15:22Z",
* "notices": [
* {
* "name": "string",
* "address": {
* "address": null,
* "isCurrent": null,
* "isPaf": null,
* "residents": [ ],
* "otherResidents": null,
* "electoralRollHistory": [ ],
* "undeclaredAddressType": null
},
* "reference": "string",
* "comment": "string",
* "type": "string",
* "dateRaised": "2019-08-24T14:15:22Z"
}
]
}
],
* "history": [
* {
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": null,
* "name": null,
* "duration": null,
* "startDate": null,
* "endDate": null,
* "electoralRollValid": null,
* "electoralRollHistory": [ ],
* "notices": [ ]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "undeclaredAddressType": "string"
},
* "addressMatch": "string",
* "balance": 0,
* "date": "2019-08-24T14:15:22Z",
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z",
* "jointApplication": true,
* "linkType": "string",
* "name": "string",
* "tpOptIn": true,
* "organisationName": "string",
* "organisationType": "string",
* "ownSearch": true,
* "purpose": "string",
* "reason": "string",
* "reference": "string",
* "supplierReference": "string",
* "subsequentEnquiry": true,
* "term": 0,
* "transient": true,
* "creditType": "string",
* "unitName": "string",
* "userName": "string",
* "searchDate": "2019-08-24T14:15:22Z",
* "searchUnitName": "string",
* "searchOrganisationName": "string",
* "searchOrganisationType": "string"
}
],
* "notices": [
* {
* "name": "string",
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* {
* "matchType": null,
* "name": null,
* "duration": null,
* "startDate": null,
* "endDate": null,
* "electoralRollValid": null,
* "electoralRollHistory": [ ],
* "notices": [ ]
}
],
* "otherResidents": true,
* "electoralRollHistory": [
* {
* "startDate": null,
* "optOut": null,
* "rollingRoll": null,
* "notices": [ ]
}
],
* "undeclaredAddressType": "string"
},
* "reference": "string",
* "comment": "string",
* "type": "string",
* "dateRaised": "2019-08-24T14:15:22Z"
}
],
* "demographics": {
* "cameoCode": "string",
* "cameoInvestorCode": "string",
* "cameoIncomeCode": "string",
* "cameoUnemploymentCode": "string",
* "cameoPropertyCode": "string",
* "cameoFinanceCode": "string",
* "cameoFinanceGroup": "string",
* "cameoIncomeGroup": "string",
* "cameoInvestmentGroup": "string",
* "cameoGroup": "string",
* "familyComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "ageComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "economicComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "economicActivityComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "hasValues": true,
* "houseTypeComposition": [
* {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
}
],
* "householdComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "lifestageComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "mortgageComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "neighbourhoodDefinition": {
* "financeGroup": "string",
* "financeGroupHouseholdPerc": "string",
* "income": "string",
* "incomeGroup": "string",
* "investorHouseholdPerc": "string",
* "investorIndex": "string",
* "riskFactor": "string",
* "uk": "string",
* "ukGroup": "string",
* "ukHouseholdPerc": "string",
* "description": "string"
},
* "occupationComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "propertyComposition": {
* "averageDetachedPropertyValue": "string",
* "averageDetachedPropertyValueDescription": "string",
* "averageFlatPropertyValue": "string",
* "averageFlatPropertyValueDescriptionField": "string",
* "averageHouseAge": "string",
* "averageSemiDetachedPropertyValue": "string",
* "averageSemiDetachedPropertyValueDescription": "string",
* "averageTerracePropertyValue": "string",
* "averageTerracePropertyValueDescription": "string",
* "councilTaxBand": "string",
* "councilTaxBandDescription": "string",
* "householdDensity": "string",
* "locationType": "string",
* "nationalAverageHousePrice": "string",
* "nationalAverageHousePriceAboveOrBelow": "string",
* "nationalAverageHousePriceDifference": "string",
* "averageFlatPropertyValueDescription": "string"
},
* "shareholderComposition": {
* "averageInvestments": "string",
* "averageInvestmentsDescription": "string",
* "averageInvestmentsLabel": "string",
* "averageShareholders": "string",
* "averageShareholdersDescription": "string",
* "averageShareholdersLabel": "string",
* "averageShares": "string",
* "averageSharesDescription": "string",
* "averageSharesLabel": "string",
* "averageValue": "string",
* "averageValueDescription": "string",
* "averageValueLabel": "string",
* "proportionOfHouseholdsWithShares": "string",
* "proportionOfHouseholdsWithSharesDescription": "string",
* "proportionOfHouseholdsWithSharesLabel": "string"
},
* "socialClassComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "tenureComposition": {
* "sortOrder": 0,
* "description": "string",
* "label": "string",
* "score": "string"
},
* "unemploymentComposition": {
* "maleLongTermUnemployment": "string",
* "maleLongTermUnemploymentDescription": "string",
* "maleLongTermUnemploymentLabel": "string",
* "unemploymentAmong18to24YearOlds": "string",
* "unemploymentAmong18to24YearOldsDescription": "string",
* "unemploymentAmong18to24YearOldsLabel": "string",
* "unemploymentAmong25to39YearOlds": "string",
* "unemploymentAmong25to39YearOldsDescription": "string",
* "unemploymentAmong25to39YearOldsLabel": "string",
* "unemploymentAmongThoseAged40andOlder": "string",
* "unemploymentAmongThoseAged40andOlderDescription":
"string",
* "unemploymentAmongThoseAged40andOlderLabel": "string",
* "unemploymentScoreLabel": "string",
* "unemploymentScoreDescription": "string",
* "unemploymentScore": "string",
* "maleLongTermUnemploymentScore": "string"
}
},
* "thirdPartyAlerts": {
* "decision": 0,
* "review": 0,
* "hho": 0
},
* "shareAccounts": [
* {
* "supplierDetails": {
* "behaviouralData": true,
* "supplierName": "string",
* "supplierType": "string"
},
* "history": [
* {
* "yearAndMonth": "string",
* "balance": 0,
* "limit": 0,
* "status": "string",
* "statusDescription": "string",
* "paymentStatus": "string",
* "paymentStatusDescription": "string",
* "statementBalance": 0,
* "paymentAmount": 0,
* "cashAdvanceCount": 0,
* "cashAdvancesTotal": 0
}
],
* "holderDetails": {
* "name": "string",
* "address": {
* "address": "string",
* "isCurrent": true,
* "isPaf": true,
* "residents": [
* null
],
* "otherResidents": true,
* "electoralRollHistory": [
* null
],
* "undeclaredAddressType": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "status": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "default": {
* "date": "2019-08-24T14:15:22Z",
* "originalBalance": 0,
* "terminationBalance": 0,
* "satisfactionDate": "2019-08-24T14:15:22Z",
* "repossessionDate": "2019-08-24T14:15:22Z"
},
* "delinquency": {
* "date": "2019-08-24T14:15:22Z",
* "balance": 0
},
* "historyBatches": [
* {
* "accountHistory": [
* null
],
* "isFirstBatch": true,
* "isLastBatch": true
}
],
* "details": {
* "accountNumber": "string",
* "accountSuffix": 0,
* "joint": true,
* "status": "string",
* "dateUpdated": "2019-08-24T14:15:22Z",
* "currencyCode": "string",
* "balance": 0,
* "limit": 0,
* "openingBalance": 0,
* "arrangementStartDate": "2019-08-24T14:15:22Z",
* "arrangementEndDate": "2019-08-24T14:15:22Z",
* "paymentStartDate": "2019-08-24T14:15:22Z",
* "accountStartDate": "2019-08-24T14:15:22Z",
* "accountEndDate": "2019-08-24T14:15:22Z",
* "regularPayment": 0,
* "expectedPayment": 0,
* "actualPayment": 0,
* "repaymentPeriod": 0,
* "lumpPayment": 0,
* "penaltyInterestAmount": 0,
* "promotionalRate": true,
* "minimumPayment": true,
* "statementBalance": 0,
* "typeCode": "string",
* "type": "string",
* "groupId": 0,
* "repaymentFrequencyCode": "string",
* "repaymentFrequency": "string"
},
* "notices": [
* {
* "name": "string",
* "address": {
* "address": null,
* "isCurrent": null,
* "isPaf": null,
* "residents": [ ],
* "otherResidents": null,
* "electoralRollHistory": [ ],
* "undeclaredAddressType": null
},
* "reference": "string",
* "comment": "string",
* "type": "string",
* "dateRaised": "2019-08-24T14:15:22Z"
}
]
}
]
},
* "dateAndTimeOfReport": "2019-08-24T14:15:22Z",
* "gaugeVersion": "string",
* "reason": "string",
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "id": {
* "authenticationID": "string",
* "bandText": "string",
* "birthIndexMatch": true,
* "chainID": "string",
* "documents": { },
* "noRetry": true,
* "resultCodes": {
* "property1": {
* "id": 0,
* "name": "string",
* "description": "string",
* "address": 0,
* "alert": 0,
* "dateOfBirth": 0,
* "forename": 0,
* "surname": 0,
* "pass": 0,
* "comments": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "match": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "misMatch": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "sanctions": [
* {
* "detail": {
* "aliases": [
* null
],
* "fullName": "string",
* "identityInformation": [
* null
],
* "addresses": [
* null
],
* "sanctionBodies": [
* null
],
* "dates": [
* null
]
},
* "id": "string",
* "score": 0,
* "url": "string"
}
],
* "peps": [
* { }
]
},
* "property2": {
* "id": 0,
* "name": "string",
* "description": "string",
* "address": 0,
* "alert": 0,
* "dateOfBirth": 0,
* "forename": 0,
* "surname": 0,
* "pass": 0,
* "comments": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "match": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "misMatch": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "sanctions": [
* {
* "detail": {
* "aliases": [
* null
],
* "fullName": "string",
* "identityInformation": [
* null
],
* "addresses": [
* null
],
* "sanctionBodies": [
* null
],
* "dates": [
* null
]
},
* "id": "string",
* "score": 0,
* "url": "string"
}
],
* "peps": [
* { }
]
}
},
* "score": 0,
* "searchText": "string",
* "legacyUniqueID": "string",
* "validationID": "string",
* "hasAlerts": true,
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "aml": {
* "authenticationID": "string",
* "bandText": "string",
* "birthIndexMatch": true,
* "chainID": "string",
* "documents": { },
* "noRetry": true,
* "resultCodes": {
* "property1": {
* "id": 0,
* "name": "string",
* "description": "string",
* "address": 0,
* "alert": 0,
* "dateOfBirth": 0,
* "forename": 0,
* "surname": 0,
* "pass": 0,
* "comments": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "match": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "misMatch": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "sanctions": [
* {
* "detail": {
* "aliases": [
* null
],
* "fullName": "string",
* "identityInformation": [
* null
],
* "addresses": [
* null
],
* "sanctionBodies": [
* null
],
* "dates": [
* null
]
},
* "id": "string",
* "score": 0,
* "url": "string"
}
],
* "peps": [
* { }
]
},
* "property2": {
* "id": 0,
* "name": "string",
* "description": "string",
* "address": 0,
* "alert": 0,
* "dateOfBirth": 0,
* "forename": 0,
* "surname": 0,
* "pass": 0,
* "comments": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "match": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "misMatch": [
* {
* "code": 0,
* "description": "string",
* "override": "string"
}
],
* "sanctions": [
* {
* "detail": {
* "aliases": [
* null
],
* "fullName": "string",
* "identityInformation": [
* null
],
* "addresses": [
* null
],
* "sanctionBodies": [
* null
],
* "dates": [
* null
]
},
* "id": "string",
* "score": 0,
* "url": "string"
}
],
* "peps": [
* { }
]
}
},
* "score": 0,
* "searchText": "string",
* "legacyUniqueID": "string",
* "validationID": "string",
* "hasAlerts": true,
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
}
}
],
* "message": "string",
* "errors": {
* "property1": [
* "string"
],
* "property2": [
* "string"
]
}
}
SETS THE REFERENCE FOR AN EXISTING HISTORY ITEM
put/localSolutions/GB/identitysearch/history/{uniqueId}/reference
https://connect.creditsafe.com/v1/localSolutions/GB/identitysearch/history/{uniqueId}/reference
https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch/history/{uniqueId}/reference
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
uniqueId
required
string
The ID of the record to update
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
string
RESPONSES
200
Success
400
Bad Request
500
Server Error
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
"string"
RESPONSE SAMPLES
* 200
* 400
* 500
Content type
application/json
Copy
"string"
REVALIDATE A GIVEN IDENTITYSEARCH WITH ADDITIONAL DOCUMENTS
put/localSolutions/GB/identitysearch/revalidation/{uniqueId}
https://connect.creditsafe.com/v1/localSolutions/GB/identitysearch/revalidation/{uniqueId}
https://connect.sandbox.creditsafe.com/v1/localSolutions/GB/identitysearch/revalidation/{uniqueId}
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
uniqueId
required
string
The ID of the record to update
HEADER PARAMETERS
Authorization
required
string
Authorization Token
REQUEST BODY SCHEMA: APPLICATION/JSON
uniqueId
string or null
passport
object (Connect.Identity.Passport)
driversLicense
object (Connect.Identity.DriversLicense)
electricitySupplier
object (Connect.Identity.ElectricitySupplier)
europeanIDCard
object (Connect.Identity.EuropeanIDCard)
niNumber
object (Connect.Identity.NINumber)
bankAccountDetails
object (Connect.Identity.BankAccountDetails)
RESPONSES
200
Success
400
Bad Request
500
Server Error
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "uniqueId": "string",
* "passport": { },
* "driversLicense": { },
* "electricitySupplier": { },
* "europeanIDCard": { },
* "niNumber": { },
* "bankAccountDetails": { }
}
RESPONSE SAMPLES
* 200
* 400
* 500
Content type
application/json
Copy
Expand all Collapse all
{
* "input": {
* "uniqueId": "string",
* "common": {
* "person": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "customerId": 0,
* "userId": 0,
* "reference": "string",
* "isInternal": true
},
* "consumer": {
* "secondPerson": {
* "currentName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "previousName": {
* "title": "string",
* "forename": "string",
* "otherNames": "string",
* "surname": "string",
* "suffix": "string"
},
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": 0,
* "addresses": {
* "current": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous1": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous2": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
},
* "previous3": {
* "buildingNo": "string",
* "buildingName": "string",
* "street": "string",
* "city": "string",
* "country": "string",
* "postCode": "string",
* "startDate": "2019-08-24T14:15:22Z",
* "endDate": "2019-08-24T14:15:22Z"
}
}
},
* "balanceOrLimit": 0,
* "transient": true,
* "creditType": "string",
* "term": "string",
* "reason": 0,
* "thirdPartyOptIn": true,
* "originalSearchRef": "string",
* "addressLink": true,
* "associateLink": true,
* "resolvedPicklist": [
* "string"
],
* "cachedPicklist": { },
* "isSubsequent": true
},
* "idAml": {
* "landlineNumber": "string",
* "exDirectory": true,
* "sortCode": "string",
* "bankAccountNumber": "string"
},
* "products": [
* 0
]
},
* "common": {
* "customerId": 0,
* "userId": 0,
* "uniqueId": "string",
* "searchText": "string",
* "reference": "string",
* "searchTime": "2019-08-24T14:15:22Z"
},
* "consumer": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "id": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "aml": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "bankMatch": {
* "success": true,
* "supplierId": "string",
* "supplierOriginalId": "string",
* "creditsIncurred": 0
},
* "picklist": [
* {
* "type": "string",
* "applicantId": 0,
* "address": "string",
* "name": "string",
* "inputs": {
* "name": "string",
* "address": "string"
},
* "options": [
* {
* "option": "string",
* "value": "string"
}
]
}
],
* "message": "string",
* "errors": {
* "property1": [
* "string"
],
* "property2": [
* "string"
]
}
}
CONSUMERS
Endpoints to order Consumer Reports. In order to order a Consumer Report,
sufficient information to uniquely identify the Consumer (search criteria) must
be provided to filter potential results down to one record. When one record has
been found, the returned object will be the Consumer Report. Currently only
piloting with German Consumers.
CONSUMER REPORT
get/consumers
https://connect.creditsafe.com/v1/consumers
https://connect.sandbox.creditsafe.com/v1/consumers
Consumer Search and Report endpoint. When sufficient information has been
provided to filter potential Consumer results down to one record then the
Consumer Report will be returned.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
countries
required
string (Creditsafe.GlobalData.CountryCode)
Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT"
"AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BA" "BW" "BV" "BR"
"IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC"
"CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC"
"EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM"
"GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM"
"HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO"
"KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU"
"MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD"
"MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "AN" "NC" "NZ" "NI" "NE"
"NG" "NU" "NF" "MP" "NO" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL"
"PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM"
"ST" "SA" "SN" "RS" "SC" "SL" "SG" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD"
"SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN"
"TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VA" "VE" "VN"
"VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "XK" "SS" "PLC"
Example: countries=DE
ISO-2 country code
firstName
required
string
Consumer's First Name
lastName
required
string
Consumer's Last Name
street
required
string
Address part identifier - Street of the Consumer
houseNo
required
string
Address part identifier - House/Building Number of the Consumer
city
required
string
Address part identifier - City of the Consumer
postCode
required
string
Address part identifier - Postcode/Zip Code of the Consumer
language
string or null = 2 characters
Default: "EN"
dateOfBirth
string or null <date-time>
customData
string or null
Example: customData=de_reason_code::ER
callRef
string or null
Default: null
Call Reference
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "totalSize": 0,
* "consumers": [
* {
* "consumerInformation": {
* "name": "string",
* "firstName": "string",
* "surname": "string",
* "age": 0,
* "dateOfBirth": "2019-08-24T14:15:22Z",
* "gender": "Unknown",
* "consumerID": "string",
* "address": {
* "type": "string",
* "simpleValue": "string",
* "street": "string",
* "houseNo": "string",
* "city": "string",
* "postCode": "string",
* "province": "string",
* "telephone": "string",
* "directMarketingOptOut": true,
* "directMarketingOptIn": true,
* "country": "AF"
},
* "additionalData": { }
},
* "incomes": [
* {
* "incomeYear": 0,
* "taxClass": "string",
* "netWealth": 0,
* "netIncome": 0,
* "sumTax": 0,
* "grossIncome": 0,
* "municipalityNr": "string"
}
],
* "registeredProperty": 0,
* "registeredHousingShare": 0,
* "directorships": [
* {
* "companyName": "string",
* "companyStatus": "string",
* "appointmentDate": "2019-08-24T14:15:22Z",
* "turnover": 0,
* "creditRating": "string",
* "companyNumber": "string",
* "function": "string",
* "companyRegistrationDate": "2019-08-24T14:15:22Z",
* "netWorth": 0,
* "creditLimit": 0
}
],
* "paymentRemarks": [
* {
* "unsettledROPNumber": 0,
* "partlySettledROPNumber": 0,
* "voluntaryPledgeNumber": 0,
* "unsettledROPAmount": 0,
* "partlySettledROPAmount": 0,
* "voluntaryPledgeAmount": 0
}
],
* "paymentRemarksDetails": [
* {
* "type": "string",
* "date": "2019-08-24T14:15:22Z",
* "source": "string",
* "refNr": "string",
* "amount": 0,
* "creditor": "string",
* "status": "string"
}
],
* "voluntaryPledges": [
* {
* "type": "string",
* "date": "2019-08-24T14:15:22Z",
* "source": "string",
* "refNr": "string",
* "amount": 0,
* "creditor": "string",
* "status": "string"
}
],
* "consumerRating": {
* "currentCreditRating": {
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string"
},
* "currentContractLimit": {
* "currency": "AFA",
* "value": 0
},
* "previousCreditRating": {
* "commonValue": "A",
* "commonDescription": "string",
* "creditLimit": {
* "currency": "AFA",
* "value": "string"
},
* "providerValue": {
* "maxValue": "string",
* "minValue": "string",
* "value": "string"
},
* "providerDescription": "string",
* "pod": 0,
* "assessment": "string"
},
* "latestRatingChangeDate": "2019-08-24T14:15:22Z"
},
* "additionalInformation": { }
}
]
}
CONSUMER SEARCH CRITERIA
get/consumers/searchcriteria
https://connect.creditsafe.com/v1/consumers/searchcriteria
https://connect.sandbox.creditsafe.com/v1/consumers/searchcriteria
Returns country specific fields that can be used to search for a Consumer.
AUTHORIZATIONS:
bearerToken
QUERY PARAMETERS
countries
string
Comma-separated list of ISO-2 country codes
callRef
string
Call Reference
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "countries": [
* "AF"
],
* "criteriaSets": [
* { }
]
}
]
MISC
Supporting endpoints for metadata/discovery. Not frequently used directly in
integrations.
REPORT SCHEMA
get/companies/schema/{countryCode}
https://connect.creditsafe.com/v1/companies/schema/{countryCode}
https://connect.sandbox.creditsafe.com/v1/companies/schema/{countryCode}
Returns the Company Report JSON schema of the provided country. Largely
redundant as the Company Report 200 response is defined as a superset of all
country's JSON schemas and can be used for any country.
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
countryCode
required
string
ISO2 / Alpha 2 Country Code
QUERY PARAMETERS
section
string
Enum: "CompanyReportResponse" "DirectorReportResponse"
Use CompanyReportResponse for the Company Credit Report JSON schema,
DirectorReportResponse for the Director Report JSON schema.
template
string
For Templated Company Report JSON Schemas
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
401
RESPONSE SAMPLES
* 200
* 401
Content type
application/json
Copy
{ }
CUSTOM REPORT PARAMETERS
get/reportcustomdata/{country}
https://connect.creditsafe.com/v1/reportcustomdata/{country}
https://connect.sandbox.creditsafe.com/v1/reportcustomdata/{country}
Returns the allowed values of the customData parameter, used in the GET Company
Report and Director Report endpoints. I.e. Supplying DE as a country code will
return a list of reasons for requesting a DE Credit Report (a legal requirement
to supply with each Credit Report request in Germany). This will provide a list
of allowedValues to enter into the mandatory Parameter customData =
de_reason_code::allowedValue
AUTHORIZATIONS:
bearerToken
PATH PARAMETERS
country
required
string
An ISO/Alpha-2 country code to display any special mandatory parameters when
ordering a Credit Report in that territory.
HEADER PARAMETERS
Authorization
required
string
Authorization Token
RESPONSES
200
400
401
RESPONSE SAMPLES
* 200
* 400
* 401
Content type
application/json
Copy
Expand all Collapse all
{
* "customData": [
* {
* "key": "de_reason_code",
* "optional": false,
* "allowedValues": [
* "1",
* "2",
* "3",
* "4",
* "5",
* "6",
* "7",
* "8"
],
* "description": "DE report retrieval reason code:\n1 - Credit
Decisioning\n2 - Credit Assessment - Future business connection (with
credit risk)\n3 - Credit Assessment - Existing business connection
(with credit risk)\n4 - Realisation check receivables collection\n5 -
Purchase Contract - Intention of signature of purchase contract (with
credit risk)\n6 - Goods Credit Insurance (with credit risk)\n7 -
Contract - Intention of signature of leasing or rent contract (with
credit risk)\n8 - Insurance Contract - Intention of signature of a
insurance contract (with credit risk)"
}
],
* "country": "DE"
}
Documentation
Credit Reports
* Company Credit Check
* International Credit Reports
* Consumer Credit Reports
Payments & Collections
* Bank Verification Checks
* Debt Collection
* Ledger Management
Compliance
* Tracing & Investigation
* ID & KYC Checks
* Know Your Business (KYB)
* Anti-Money Laundering
* PEPs & Sanctions Checks
Data Management
* Improve data accuracy
* Build global marketing lists
* License our data
Connect API
* Creditsafe API
* API Documentation
About
* Our Story
* Our Data
* Supporting GDPR
* Careers
Help & Support
* Contact us
* Help Hub
* Our Customer Service
Packages
* Product Packages
Follow us
Cookie Settings
Sales & Support
02920 886 500
Contact Support
Credit Reports
* Company Credit Check
* International Credit Reports
* Consumer Credit Reports
Payments & Collections
* Bank Verification Checks
* Debt Collection
* Ledger Management
Compliance
* Tracing & Investigation
* ID & KYC Checks
* Know Your Business (KYB)
* Anti-Money Laundering
* PEPs & Sanctions Checks
Data Management
* Improve data accuracy
* Build global marketing lists
* License our data
Connect API
* Creditsafe API
* API Documentation
About
* Our Story
* Our Data
* Supporting GDPR
* Careers
Help & Support
* Contact us
* Help Hub
* Our Customer Service
Packages
* Product Packages
02920 886 500
Contact Support
Creditsafe Business Solutions Limited is authorised and regulated by the
Financial Conduct Authority (FCA FRN 742313).
Terms of Service | Privacy Policy | Cookie Policy | Modern Slavery Statement |
Transparency Notices
© Creditsafe Business Solutions Ltd 2022
Our website uses cookies to give you the best online experience and to allow us
and third parties to personalise advertising. Please let us know if you agree to
all of these cookies.
No, take me to settings Yes, I agree
* STRICTLY NECESSARY COOKIES
Always Active
Strictly Necessary Cookies
These cookies are necessary for the website to function and cannot be
switched off in our systems. They are usually only set in response to actions
made by you which amount to a request for services, such as setting your
privacy preferences, logging in or filling in forms. You can set your browser
to block or alert you about these cookies, but some parts of the site will
not then work. These cookies do not store any personally identifiable
information.
Cookies Details
* PERFORMANCE COOKIES
Performance Cookies
These cookies allow us to count visits and traffic sources so we can measure
and improve the performance of our site. They help us to know which pages are
the most and least popular and see how visitors move around the site. All
information these cookies collect is aggregated and therefore anonymous. If
you do not allow these cookies we will not know when you have visited our
site, and will not be able to monitor its performance.
Cookies Details
* TARGETING COOKIES
Targeting Cookies
These cookies may be set through our site by our advertising partners. They
may be used by those companies to build a profile of your interests and show
you relevant adverts on other sites. They do not store directly personal
information, but are based on uniquely identifying your browser and internet
device. If you do not allow these cookies, you will experience less targeted
advertising.
Cookies Details
* FUNCTIONAL COOKIES
Functional Cookies
These cookies enable the website to provide enhanced functionality and
personalisation. They may be set by us or by third party providers whose
services we have added to our pages. If you do not allow these cookies then
some or all of these services may not function properly.
Cookies Details
PRIVACY PREFERENCE CENTER
When you visit any website, it may store or retrieve information on your
browser, mostly in the form of cookies. This information might be about you,
your preferences or your device and is mostly used to make the site work as you
expect it to. The information does not usually directly identify you, but it can
give you a more personalized web experience. Because we respect your right to
privacy, you can choose not to allow some types of cookies. Click on the
different category headings to find out more and change our default settings.
However, blocking some types of cookies may impact your experience of the site
and the services we are able to offer.
What are cookies?
Allow All Confirm My Choices
Back Button
Back
Vendor Search Search Input
ADVERTISING COOKIES
Filters (2)
Consent Leg.Interest
All Consent Allowed
Select All Vendors
Select All Vendors
Select All Hosts
Clear Filters
Information storage and access
Apply
* View Cookies
REPLACE-WITH-DYANMIC-HOST-ID
* Name
cookie name