JSON/XML: | POST https://api.sanctionssearch.com/v2/dbs/ |
JSON/XML Legacy: | POST https://api.sanctionssearch.com/v2/{json/xml}/reply/AddDbsSearch/ |
JSON/XML: POST https://api.sanctionssearch.com/v2/dbs/
This method allows you to create a DBS Search. This method will send the applicant an SMS and Email with information on how to complete the process. This feature is only available if it has been activated on your account.
Request Parameters
Parameter | Type | Format | Description |
---|---|---|---|
Name Required | String | Max length 250 characters | The full name of the applicant |
DateOfBirth Required | String | Max length 10 characters | Date of birth for the applicant. DD/MM/YYYY format. |
Email Required | String | Max length 250 characters | The email address of the applicant |
MobileInternational Required | String | Max length 15 characters | The applicant's mobile phone number in international format (e.g. '+447123456789'). |
JobLocation Required | String | Max length 100 characters |
The country where the Job is located, only one of the following values is permitted:
|
DisclosureLevel Required | String | Max length 10 characters |
The disclosure level of the DBS required, only one of the following values is permitted:
|
Reference | String | Max length 250 characters | Your reference, if any |
SubUserName | string | Null or max length 50 characters | If this is specified, the search will be created for the specified sub user, otherwise it will be created in the main user account. |
Response Parameters
Parameter | Type | Format | Description |
---|---|---|---|
ResponseStatus | ResponseStatus | Instance of ResponseStatus object (see here) | |
Summary | DBSSearchSummary | Instance of DBSSearchSummary object (see here) |