API Dashboard

Taffy 3.6.0

Resources:

v1download DELETE PATCH PUT POST GET /v1/usage/{logId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Send a request to /v1/usage/{logId} endpoint to download your saved report.
get
Use the GET method to request the content of saved report.
Inputs
required numeric logId

Log record ID

optional boolean convertHtmlToPdf (default: false)

If the document is in HTML format, convert it into PDF

v1usage DELETE PATCH PUT POST GET /v1/usage

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Send a request to /v1/usage endpoint to get your usage report.
get
Use the GET method to request your usage.
Inputs
optional string from

Default - start of this month

optional string until

Default - now

optional numeric page (default: 1)

Page number

optional numeric items (default: 20)

Items per page

v1token DELETE PATCH PUT POST GET /v1/token

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Send a request to /v1/token to receive access token.
get
Use the GET method to exchange your API key and secret to access token.
Inputs
required string apiKey

API key provided by CoCredo

required string apiSecret

API secret provided by CoCredo

v1test DELETE PATCH PUT POST GET /v1/test

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

v1notices DELETE PATCH PUT POST GET /v1/monitor/notices

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Send a request to /v1/monitor/notices endpoint to get notices.
get
Use the GET method to request notices.
Inputs
optional string from

Default - start of yesterday

optional string until

Default - end of yesterday

optional numeric cocredoId (default: 0)

Company ID

optional numeric portfolioId (default: 0)

Portfolio ID

optional numeric page (default: 1)

Page number

optional numeric items (default: 20)

Items per page

v1monitor DELETE PATCH PUT POST GET /v1/monitor/{cocredoId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Send a request to /v1/monitor/{cocredoId} endpoint to manage company monitoring status
delete
Use the DELETE method to remove company from monitoring.
Inputs
required numeric cocredoId

CoCredo ID of the company

get
Use the GET method to request monitor status.
Inputs
required numeric cocredoId

CoCredo ID of the company

put
Use the PUT method to add company to monitoring.
Inputs
required numeric cocredoId

CoCredo ID of the company

v1investigations DELETE PATCH PUT POST GET /v1/investigations

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Send a request to /v1/investigations endpoint to raise an investigation or to get investigation status
get
Use the GET method to request investigation status.
Inputs
optional numeric investigationId

Investigation ID

optional numeric page (default: 1)

Page number

optional numeric items (default: 20)

Items per page

put
Use the PUT method to request an investigation.
Inputs
required numeric type

1 - unable to find company, 2 - failed to load data packet

optional numeric cocredoId

CoCredo ID of the company

optional string companyName (default: "")

Company name

optional string countryCode (default: "")

Country code

optional string regNumber (default: "")

Company registration number

optional string vatNumber (default: "")

VAT registration number

optional string address (default: "")

Registered address

optional string town (default: "")

City or town

optional string postcode (default: "")

Post/zip code

optional string contactName (default: "")

Contact name

optional string phone (default: "")

Telephone number

optional string website (default: "")

Website URL

optional string email (default: "")

Email address

optional string otherInformation (default: "")

Other information

v1hello DELETE PATCH PUT POST GET /v1/hello

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

get
Inputs

v1director DELETE PATCH PUT POST GET /v1/directors/{directorId}

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Send a request to /v1/directors/{directorId} endpoint to get director details.
get
Use the GET method to request a director report.
Inputs
required string directorId (default: "")

Director ID

v1directors DELETE PATCH PUT POST GET /v1/directors

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Send a request to /v1/directors endpoint to find a director.
get
Use the GET method to make a search request.
Inputs
required string directorName

Director name

optional string countryCode (default: GB)

2-character country code

optional string officerType (default: CUR)

CUR - current or resigned, DIS - disqualified

optional numeric page (default: 1)

Page number

optional numeric items (default: 20)

Items per page

v1reports DELETE PATCH PUT POST GET /v1/company/{cocredoId}/reports

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Send a request to /v1/company/{cocredoId}/reports endpoint.
get
Get the list of company reports available.
Inputs
required numeric cocredoId

Company ID

v1report DELETE PATCH PUT POST GET /v1/company/{cocredoId}/report

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Send a request to /v1/company/{cocredoId}/report endpoint to run a report.
get
Get company credit report.
Inputs
required numeric cocredoId

CoCredo ID of the company

required numeric productId

Product ID of the selected report

optional numeric investigationId

Investigation ID if the report is a result of an investigation

optional boolean monitorAdd (default: false)

True - monitor changes of the company

optional boolean dnaAdd (default: false)

True - add to the default portfolio

optional string contentType (default: JSON)

JSON, HTML or PDF

v1documents DELETE PATCH PUT POST GET /v1/company/{cocredoId}/documents

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Send a request to /v1/company/{cocredoId}/documents endpoint.
get
Get the list of company documents available
Inputs
required numeric cocredoId

Company ID

optional numeric page (default: 1)

Page number

optional numeric items (default: 20)

Items per page

v1document DELETE PATCH PUT POST GET /v1/company/{cocredoId}/document

+Query Params  +Accept  +Headers  +Basic Auth

URI Tokens: (required)

Request Body:

Loading...

Response:

Send a request to /v1/company/{cocredoId}/document endpoint to download a document.
get
Get company document
Inputs
required numeric cocredoId

CoCredo ID of the company

required string documentId

ID of the selected document

v1companies DELETE PATCH PUT POST GET /v1/companies

+Query Params  +Accept  +Headers  +Basic Auth

Request Body:

Loading...

Response:

Send a request to /v1/companies endpoint to find a company.
get
Use the GET method to make a search request.
Inputs
optional string companyName (default: "")

Company name

required string countryCode (default: "")

2-character country code

optional string regNumber (default: "")

Registration number

optional string vatNumber (default: "")

VAT number

optional string postcode (default: "")

Postcode

optional string town (default: "")

Town

optional string phone (default: "")

Telephone number

optional string officeType (default: "")

US office type

optional string cocredoId (default: "")

Company ID

optional string reference (default: "")

Customer reference


Resources are listed in matching order. From top to bottom, the first URI to match the request is used.