Creditsafe Connect API Documentation

People/Director Search Criteria

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

SecuritybearerToken

Request

query Parameters

countries

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 People/Director fields in the United States and Great Britain.

Responses

200

400

401

get/people/searchcriteria

Request samples

Response samples

application/json

{"messages": [{"type": "Information",
"code": "NoResults",
"text": "string"
}
],
"countriesCriteria": [{"country": "AF",
"schemas": [{"id": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"firstName": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"lastName": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"companyId": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"companyName": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"companyType": {"optional": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["NotSet"
],
"validationRegExp": "string"
},
"companyRegistrationNumber": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
},
"address": {"simpleValue": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": [null
],
"validationRegExp": "string"
},
"street": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": [null
],
"validationRegExp": "string"
},
"houseNo": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": [null
],
"validationRegExp": "string"
},
"city": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": [null
],
"validationRegExp": "string"
},
"postCode": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": [null
],
"validationRegExp": "string"
},
"province": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": [null
],
"validationRegExp": "string"
}
},
"status": {"required": true,
"minLength": 0,
"maxLength": 0,
"allowedValues": ["string"
],
"validationRegExp": "string"
}
}
]
}
],
"customData": [{"key": "string",
"optional": true,
"allowedValues": ["string"
],
"description": "string"
}
]
}

➔ Next to Director Search