Skip to main content
POST
Credit Report
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:

iframe

You can embed the report into an iframe on your page.

Authorizations

x-api-key
string
header
required

Path Parameters

companyId
integer<int32>
required

The company id

Body

The payload

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