Create Profile From Company Report

Imports a company business report into the system as a profile for compliance purposes.

While this endpoint allows for significant customization during the import process, the endpoint /compliance/kyc-protect/profiles/import/companies/{companyId} is the preferred method as it automates much of the processing and configuration. Use this endpoint only when the preferred endpoint cannot meet your requirements.

SecuritybearerToken
Request
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.

template
string
Default: "full"

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.

includeIndicators
boolean
Default: true

Optional parameter flag to include indicators or not.

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.

reportSections
string

Optional parameter to get specific sections of report instead of entire report.

languageFallback
boolean
Default: false

Optional parameter flag to request a report with default language.

callRef
string or null
Default: "None"

Call Reference

Request Body schema: application/json
profileName
required
string

Name of the profile.

companyId
required
string

The primary Company identifier that is used to uniquely identify all companies across Creditsafes Universe and Partner Network.

internalId
string or null

Internal Id of the profile

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404
409

Conflict

post/compliance/kyc-protect/profiles/businesses/import
Request samples
application/json
{
  • "profileName": "string",
  • "companyId": "string",
  • "internalId": "string"
}
Response samples
application/json
{
  • "correlationId": "string",
  • "kycResponse": {
    },
  • "report": {
    }
}
➔ Next to Create Profile