Creditsafe Connect API Documentation

Company Search Criteria

Returns the set of available Company Search parameters/fields for a provided list of countries.

SecuritybearerToken

Request

query Parameters

countries

required

string

A comma separated list of ISO/Alpha 2 format country codes, or singular country Code. e.g. US,GB will return the common searchable Company fields in the United States and Great Britain.

Responses

200

Successful

400

Bad Request

401

Invalid Token

403

Access Forbidden

get/companies/searchcriteria

Request samples

Response samples

application/json

{"correlationId": "string",
"countries": ["AF"
],
"languages": ["string"
],
"criteriaSets": [{"id": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"safeNo": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"regNo": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"vatNo": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"name": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"type": {"optional": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["NotSet"
],
"validationRegExp": "string"
},
"officeType": {"optional": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["registered"
],
"validationRegExp": "string"
},
"status": {"optional": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["Active"
],
"validationRegExp": "string"
},
"address": {"simpleValue": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"street": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"houseNo": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"city": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"postCode": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"province": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
}
},
"phoneNumber": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"website": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"includeTradingNames": {"optional": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": [true
],
"validationRegExp": "string"
},
"includeTradingAddresses": {"optional": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": [true
],
"validationRegExp": "string"
}
}
]
}

➔ Next to Company Search