API Documentation

Create Fresh Investigation

Credit and Risk (1.0.0)

Download OpenAPI description

creditAndRisk.json

creditAndRisk.yaml

Servers

Mock server

https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/

Sandbox server

https://connect.sandbox.creditsafe.com/v1/

Production server

https://connect.creditsafe.com/v1/

Authentication

Endpoints to authenticate and generate an Authentication Token.

Operations

Schema Structure

Endpoints to retrieve the structure of the Company and Director Search Criteria's and Reports.
The JSON schema is a blueprint of the data structure that will be returned in the response of the Company and Director Report endpoints. The schema can be used to validate the response data and understand the structure of the data returned. The schema is available for all countries and is a superset of all country's JSON schemas.

Operations

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.

Operations

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.

Operations

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.

Operations

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.

Operations

Create Fresh Investigation

Request

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.

Bodyapplication/json

consentboolean

Including this allows Creditsafe to disclose your company details to the target company in the aim of improving the quality of our Investigation Report

contactInfoobject

Your contact information

chargeReferencestring

Free text field to add your own personal reference to the order

searchCriteriaobject

Details on the company you are investigating - the target company

curl -i -X POST \
  https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/freshinvestigations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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"
    }
  }'

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

messagestring

orderIDstring

Fresh Investigation Unique Identifier

transactionIDstring

Fresh Investigation Internal Identifier

Response

application/json

{
  "correlationId": "string",
  "message": "string",
  "orderID": "string",
  "transactionID": "string"
}

Get Fresh Investigations

Request

Returns a list of your submitted Fresh Investigation Orders.

Query

pageinteger

Starting page number.

Default 1

pageSizeinteger

Number of items to return per Page.

transactionIdstring

Fresh Investigation Identifier used internally and with our data partners.

reportCreatedAfterstring

Returns Fresh Investigations processed after this date

Example: reportCreatedAfter=2020-01-01T11:23:56Z

reportCreatedBeforestring

Returns ordered Fresh Investigations that were processed before this date

Example: reportCreatedBefore=2020-01-01T11:23:56Z

createdBeforestring

Returns Fresh Investigations created before this date

createdSincestring

Returns ordered Fresh Investigations created after this date

lookUpOrderBystring

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

Enum"CompanyDetails""SearchCriteria"

companyDetailsCountrystring

Looks for your returned Fresh Investigations where the returned Company Country is named this. Use with lookUpOrderBy=CompanyDetails

companyDetailsNamestring

Looks for your returned Fresh Investigations where the returned Company Name is named this. Use with lookUpOrderBy=CompanyDetails

searchCriteriaCountrystring

Looks for your returned Fresh Investigations where your submitted Search Criteria Company Country is this. Use with lookUpOrderBy=searchCriteria

searchCriteriaNamestring

Looks for your Fresh Investigations where your submitted Search Criteria Company Name is this. Use with lookUpOrderBy=searchCriteria

sortBystring

Sorts returned Fresh Investigations by this field

Enum"creationDate""lastStatusChangeDate""orderID""status"

sortDirstring

The direction that you wish to sort results by.

Default "asc"

Enum"asc""desc"

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/freshinvestigations?companyDetailsCountry=string&companyDetailsName=string&createdBefore=string&createdSince=string&lookUpOrderBy=CompanyDetails&page=1&pageSize=0&reportCreatedAfter=2020-01-01T11%3A23%3A56Z&reportCreatedBefore=2020-01-01T11%3A23%3A56Z&searchCriteriaCountry=string&searchCriteriaName=string&sortBy=creationDate&sortDir=asc&transactionId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

totalCountinteger

ordersArray of objects

Response

application/json

{
  "totalCount": 0,
  "orders": [
    { … }
  ]
}

Retrieve FreshInvestigation Order

Request

Returns a specific Fresh Investigation order.

Path

orderIdstringrequired

Query

sectionsstring

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

Example: sections=companyIdentification,creditScore

commentsstring

Selects number of comments which should be returned with the order details.

Default "last"

Enum"last""recent""none"

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/freshinvestigations/{orderId}?comments=last&sections=companyIdentification%2CcreditScore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns a specific Fresh Investigation Order. For completed orders this will contain the Investigation content as Report Sections.

Bodyapplication/json

chargeReferencestring

contactDetailsobject

creationDatestring

lastStatusChangeDatestring

orderIDinteger

reportDatestring

searchCriteriaobject

sectionsArray of objects

statusobject

transactionIDinteger

Response

application/json

{
  "chargeReference": "string",
  "contactDetails": {
    "emailAddress": "string",
    "name": "string",
    "telephoneNumber": "string"
  },
  "creationDate": "string",
  "lastStatusChangeDate": "string",
  "orderID": 0,
  "reportDate": "string",
  "searchCriteria": {
    "additionalInfo": "string",
    "address": { … },
    "countryCode": "string",
    "name": "string",
    "regNo": "string",
    "vatNo": "string"
  },
  "sections": [
    { … }
  ],
  "status": {
    "code": "string",
    "description": "string"
  },
  "transactionID": 0
}

Delete Fresh Investigations

Request

Deletes specified investigations.

Path

orderIdstringrequired

Investigation id.

curl -i -X DELETE \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/freshinvestigations/{orderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

messagestring

Response

application/json

{
  "message": "string"
}

Update FreshInvestigation Report Content

Request

Update the Fresh Investigation Report data for a specific order, after the order has a status of delivered.

Path

orderIdstringrequired

Fresh investigation orderId

Bodyapplication/json

consentboolean

Including this allows Creditsafe to disclose your company details to the target company in the aim of improving the quality of our Investigation Report

contactInfoobject(ConnectFreshInvInvestigationContactInfo)

Your contact information

chargeReferencestring

Free text field to add your own personal reference to the order

searchCriteriaobject(ConnectFreshInvInvestigationCompanyData)

Details on the company.

pendingInfoobject

PendingInfo property contains the information of respective sections, that someone has requested respective information to be modified.

curl -i -X PATCH \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/freshinvestigations/{orderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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": "AF"
    },
    "pendingInfo": {
      "contactDetails": {
        "name": "string",
        "emailAddress": "string",
        "telephoneNumber": "string",
        "company": {
          "name": "string",
          "number": "string"
        }
      },
      "searchCriteria": {
        "name": "string",
        "additionalInfo": "string",
        "telephoneNumber": "string",
        "address": {
          "simple": "string",
          "postcode": "string",
          "city": "string"
        },
        "regNo": "string",
        "vatNo": "string",
        "countryCode": "AF"
      }
    }
  }'

Responses

Investigation Report.

Bodyapplication/json

messagestring

Success response of updated fresh investigation.

Example: "FreshInvestigation OrderId is being updated"

Response

application/json

{
  "message": "FreshInvestigation OrderId is being updated"
}

Upload attachments for fresh investigation orderId

Request

Returns the status of attachment upload for the particular order.

Path

orderIdstringrequired

Fresh investigation orderId

Bodymultipart/form-datarequired

importFilestring(binary)

The file which we want to attach to the fresh investigation order

descriptionstring

Description of the file which we want to attach to the fresh investigation order

curl -i -X POST \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/freshinvestigations/{orderId}/attachments' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F file=FILE_PATH

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

messagestring

detailsstring

Response

application/json

{
  "correlationId": "string",
  "message": "string",
  "details": "string"
}

Get attachments for the given fresh investigation orderId

Request

Returns attachments available for that particular order.

Path

orderIdstringrequired

fresh investigation orderId

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/freshinvestigations/{orderId}/attachments' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

AttachmentsArray of objects

Response

application/json

{
  "correlationId": "string",
  "Attachments": [
    { … }
  ]
}

Get attachment for the given fresh investigation attachment Id

Request

Retrieve attachment for the given attachmentId.

Path

orderIdstringrequired

fresh investigation orderId

idstringrequired

fresh investigation attachment id for the given order

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/freshinvestigations/{orderId}/attachments/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Attachment as a binary stream.

Body

string(binary)(CreditsafeFreshInvestigationGlobalDataCoreAttachmentBinaryAttachment)

Response

No content

Comments for fresh investigation orderId

Request

Returns the status of comments for the particular order.

Path

orderIdstringrequired

fresh investigation orderId

Bodyapplication/jsonrequired

commentsstring

comments for fresh investigation orderId

curl -i -X POST \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/freshinvestigations/{orderId}/comments' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "comments": "comments by user"
  }'

Responses

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

messagestring

Response

application/json

{
  "correlationId": "string",
  "message": "string"
}

Retrieve comments of specified FreshInvestigation Report

Request

Returns the Fresh Investigation Report comments for a specific order.

Path

orderIdstringrequired

FreshInvestigation Report Id

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/freshinvestigations/{orderId}/comments' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Investigation Report.

Bodyapplication/json

totalCountinteger

Total number of comments for a FreshInvestigation Report

commentsArray of objects

Response

application/json

{
  "totalCount": 0,
  "comments": [
    { … }
  ]
}

Retrieve FreshInvestigation Report Content

Request

Returns the Fresh Investigation Report data for a specific order, after the order has a status of delivered.

Path

orderIdstringrequired

curl -i -X GET \
  'https://creditsafe-connect-api.redocly.app/_mock/connect-apis-catalog/product-catalog/creditrisk/creditandrisk/freshinvestigations/{orderId}/report' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Investigation Report.

Bodyapplication/json

correlationIdstring

A unique ID assigned to this request.

failedSectionsArray of strings(CreditsafeGlobalDataReportsReportSection)

Items Enum"CompanySummary""CompanySummaryExtra""AlternateSummary""CompanyIdentification""CompanyIdentificationExtra""CreditScore""CreditScoreExtra""ContactInformation""ContactInformationExtra""ShareCapitalStructure"

reportobject(CreditsafeGlobalDataReportsCompanyReport)

companyIdstring

dateOfOrderstring(date-time)

languagestring

userIdinteger

Response

application/json

{
  "correlationId": "string",
  "failedSections": [
    "CompanySummary"
  ],
  "report": {
    "companyId": "string",
    "language": "OM",
    "companySummary": { … },
    "companyIdentification": { … },
    "creditScore": { … },
    "contactInformation": { … },
    "indicators": [ … ],
    "shareCapitalStructure": { … },
    "directors": { … },
    "directorships": { … },
    "otherInformation": { … },
    "groupStructure": { … },
    "extendedGroupStructure": [ … ],
    "financialStatements": [ … ],
    "localFinancialStatements": [ … ],
    "negativeInformation": {},
    "additionalInformation": {},
    "directorsExtra": {},
    "extendedGroupStructureExtra": {},
    "paymentData": {},
    "paymentDataExtra": {},
    "alternateSummary": {},
    "negativeInformationExtra": {},
    "exceptions": [ … ]
  },
  "companyId": "string",
  "dateOfOrder": "2019-08-24T14:15:22Z",
  "language": "string",
  "userId": 0
}

Credit and Risk (1.0.0)

Authentication

Schema Structure

Companies

People/Directors

Images

Fresh Investigations

Create Fresh Investigation

RequestExpand all

Responses

Do you like this page?

Get Fresh Investigations

Request

Responses

Do you like this page?

Retrieve FreshInvestigation Order

Request

Responses

Do you like this page?

Delete Fresh Investigations

Request

Responses

Do you like this page?

Update FreshInvestigation Report Content

RequestExpand all

Responses

Do you like this page?

Upload attachments for fresh investigation orderId

Request

Responses

Do you like this page?

Get attachments for the given fresh investigation orderId

Request

Responses

Do you like this page?

Get attachment for the given fresh investigation attachment Id

Request

Responses

Do you like this page?

Comments for fresh investigation orderId

Request

Responses

Do you like this page?

Retrieve comments of specified FreshInvestigation Report

Request

Responses

Do you like this page?

Retrieve FreshInvestigation Report Content

Request

Responses

Do you like this page?

Request

Request