Update Enrichments Request

Request

Detail which package of enrichment settings are to be applied to the uploaded file.

Select one of the three creditTypes to acquire the JSON Enrichment tag schema possible for that product.

Removal of Enrichment tags is possible from each creditType. Addition of Enrichment tags to a creditType is not possible beyond the maximum schema for each.

Security

bearerToken

Path

idstringrequired

Bodyapplication/jsonrequired

One of:

enrichmentsArray of objects

Example:

[
  {
    "enrichment": "general.safeNumber"
  },
  {
    "enrichment": "general.connectId"
  },
  {
    "enrichment": "general.ggsId"
  },
  {
    "enrichment": "general.companyName"
  },
  {
    "enrichment": "general.companyId"
  },
  {
    "enrichment": "general.companyNameKanji"
  },
  {
    "enrichment": "general.companyNameKana"
  },
  {
    "enrichment": "general.aliasName"
  },
  {
    "enrichment": "general.tradeName"
  },
  {
    "enrichment": "general.tradeNumber"
  },
  {
    "enrichment": "general.acronym"
  },
  {
    "enrichment": "general.organisationNumber"
  },
  {
    "enrichment": "general.legalRegistrationNumber"
  },
  {
    "enrichment": "general.siret"
  },
  {
    "enrichment": "general.siren"
  },
  {
    "enrichment": "general.companyNumber"
  },
  {
    "enrichment": "general.kvkNumber"
  },
  {
    "enrichment": "contact.eircode"
  },
  {
    "enrichment": "contact.country"
  },
  {
    "enrichment": "contact.mailing.city"
  },
  {
    "enrichment": "general.companyType"
  },
  {
    "enrichment": "general.companyTypeDesc.en"
  },
  {
    "enrichment": "general.legalName"
  },
  {
    "enrichment": "general.legalNameAlt"
  },
  {
    "enrichment": "general.rsin"
  },
  {
    "enrichment": "general.tradingName"
  },
  {
    "enrichment": "general.regDeletionNumber"
  },
  {
    "enrichment": "general.pattern"
  },
  {
    "enrichment": "general.banding"
  },
  {
    "enrichment": "general.bandingDesc"
  },
  {
    "enrichment": "general.rowNumber"
  },
  {
    "enrichment": "general.duplicate"
  },
  {
    "enrichment": "general.duplicateId"
  },
  {
    "enrichment": "contact.city"
  }
]

curl -i -X PUT \
  'https://connect.sandbox.creditsafe.com/v1/dataCleaning/jobs/{id}/enrichments' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enrichments": [
      {
        "enrichment": "general.safeNumber"
      },
      {
        "enrichment": "general.connectId"
      },
      {
        "enrichment": "general.ggsId"
      },
      {
        "enrichment": "general.companyName"
      },
      {
        "enrichment": "general.companyId"
      },
      {
        "enrichment": "general.companyNameKanji"
      },
      {
        "enrichment": "general.companyNameKana"
      },
      {
        "enrichment": "general.aliasName"
      },
      {
        "enrichment": "general.tradeName"
      },
      {
        "enrichment": "general.tradeNumber"
      },
      {
        "enrichment": "general.acronym"
      },
      {
        "enrichment": "general.organisationNumber"
      },
      {
        "enrichment": "general.legalRegistrationNumber"
      },
      {
        "enrichment": "general.siret"
      },
      {
        "enrichment": "general.siren"
      },
      {
        "enrichment": "general.companyNumber"
      },
      {
        "enrichment": "general.kvkNumber"
      },
      {
        "enrichment": "contact.eircode"
      },
      {
        "enrichment": "contact.country"
      },
      {
        "enrichment": "contact.mailing.city"
      },
      {
        "enrichment": "general.companyType"
      },
      {
        "enrichment": "general.companyTypeDesc.en"
      },
      {
        "enrichment": "general.legalName"
      },
      {
        "enrichment": "general.legalNameAlt"
      },
      {
        "enrichment": "general.rsin"
      },
      {
        "enrichment": "general.tradingName"
      },
      {
        "enrichment": "general.regDeletionNumber"
      },
      {
        "enrichment": "general.pattern"
      },
      {
        "enrichment": "general.banding"
      },
      {
        "enrichment": "general.bandingDesc"
      },
      {
        "enrichment": "general.rowNumber"
      },
      {
        "enrichment": "general.duplicate"
      },
      {
        "enrichment": "general.duplicateId"
      },
      {
        "enrichment": "contact.city"
      }
    ]
  }'

Responses

Successful Response

Bodyapplication/json

object(CreditsafeGlobalDataReportsCompanyReportExtraSection)

Response

{
  "enrichments": [
    { … }
  ]
}