Creditsafe Connect API Documentation

Update Enrichments 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.

SecuritybearerToken

Request

path Parameters

required

string

Request Body schema: application/json
required

One of:

Array of objects

Responses

200

Successful Response

400

Bad Request Response

401

Invalid Token Response

403

Access Forbidden Response

404

404 response

put/dataCleaning/jobs/{id}/enrichments

Request samples

application/json

{"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"
}
]
}

Response samples

application/json

{"enrichments": [{"enrichment": "Tag Name from request body"
}
]
}

➔ Next to Start Enrichment Request

Update Enrichments Request

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required