Create Profile From Company Report

Request

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

Security

bearerToken

Query

languagestring^[a-zA-Z]{2}$

Report Language - The JSON structure of the Report is language invariant, but field content will return as the given language, where available.

Default:"en"

templatestring

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.

Default:"full"

includeIndicatorsboolean

Optional parameter flag to include indicators or not.

Default:true

customDatastring 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.

reportSectionsstring

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

languageFallbackboolean

Optional parameter flag to request a report with default language.

Default:false

callRefstring or null

Call Reference

Default:null

Bodyapplication/json

profileNamestringrequired

Name of the profile.

companyIdstringrequired

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

internalIdstring or null

Internal Id of the profile

curl -i -X POST \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/businesses/import?language=en&template=full&includeIndicators=true&customData=string&reportSections=string&languageFallback=false&callRef=%7BcallRef%7D' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "profileName": "string",
    "companyId": "string",
    "internalId": "string"
  }'

Responses

Accepted

Bodyapplication/json

correlationIdstring, (UUID)

kycResponseobject

reportobject(CreditsafeGlobalDataReportsCompanyReportResponse)

Response

{
  "correlationId": "string",
  "kycResponse": {
    "id": "string",
    "profileUrl": "string"
  },
  "report": {
    "correlationId": "string",
    "failedSections": [ … ],
    "report": { … },
    "companyId": "string",
    "dateOfOrder": "2019-08-24T14:15:22Z",
    "language": "string",
    "userId": 0
  }
}