Skip to main content
POST
/
datasets
/
companies
/
{companyId}
/
credit-report
Credit Report
curl --request POST \
  --url https://api.tic.io/datasets/companies/{companyId}/credit-report \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "consentToPricing": true,
  "sendSMSToE164MobileNumber": "<string>",
  "sendEmailToEmailAddress": "jsmith@example.com"
}
'
{
  "deliveryGuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creditReportUrl": "<string>",
  "description": "<string>",
  "priceExclVat": 123
}
This endpoint will create a fully hosted credit report (time limited) for the given company and return the URL including incurred costs. You can post also a E.164 formatted mobile phone number and we will send a text message including the full credit report to the user Also you can add an e-mail address that will receive an e-mail containing the link to the report. Remember the model that you need to post needs at minimum contain ConsentToPricing set to true. Example: 
{
  "consentToPricing": true,
  "sendSMSToE164MobileNumber": "+46xxxxxx",
  "sendEmailToEmailAddress": "some@email.tld"
}

​
iframe

You can embed the report into an iframe on your page. 
<iframe
  src="<creditReportUrl>"
  title="<description>"
  frameborder="0"
  marginheight="0"
  marginwidth="0"
  width="100%"
  height="100%"
  scrolling="auto"
>
</iframe>

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
companyId
integer<int32>
required

The company id

Body

The payload

​
consentToPricing
boolean
required
​
sendSMSToE164MobileNumber
string | null
​
sendEmailToEmailAddress
string<email> | null

Response

200 - application/json

OK

​
deliveryGuid
string<uuid>
​
creditReportUrl
string | null
​
description
string | null
​
priceExclVat
number<double> | null