| JSON/XML: | GET https://api.sanctionssearch.com/v2/dbs/ |
| JSON/XML Legacy: | POST https://api.sanctionssearch.com/v2/{json/xml}/reply/GetDbsSearches/ |
This method returns paginated DBS Search records based on the specified filtering, sorting and pagination parameters.
Request Parameters
| Parameter | Type | Format | Description |
|---|---|---|---|
| Page[offset] | Int32 | Query Param. The starting point in the list of records from where the data should be fetched. Zero based index. | |
| Page[limit] | Int32 | Query Param. The maximum number of records to be returned in one page | |
| Sort | String |
Query Param. Sort the results by the specified term. The default is status. The following values are valid:
status Order by status ascending |
|
| Name | String | Query Param. Filter the results to those that have a Name including the specified value. | |
| DateFrom | DateTime | ISO 8601 | Query Param. Filter the results to those that were created after (or on) this date. |
| DateTo | DateTime | ISO 8601 | Query Param. Filter the results to those that were created before this date. |
| IsApplicantInfoCompleted | Nullable Boolean | Query Param. Filter the results to those where the applicant has provided their information (true), or not (false), or either (null). | |
| IsIdCheckCompleted | Nullable Boolean | Query Param. Filter the results to those where the ID Checker has verified the applicant's ID (true), or not (false), or either (null). | |
| IsApplicationCompleted | Nullable Boolean | Query Param. Filter the results to those where the application is complete and ready to be submitted (true), or not (false), or either (null). | |
| IsApplicationSubmitted | Nullable Boolean | Query Param. Filter the results to those where the application has been submitted (true), or not (false), or either (null). | |
| IsApplicationDisclosed | Nullable Boolean | Query Param. Filter the results to those where the application has been disclosed (true), or not (false), or either (null). | |
| SubUserName | String | Query Param. Provide a value to only return searches that the specified sub user has permission to access. If this is null or empty, then sub user permissions will not be enforced and all applicable results will be returned. |
Response Parameters
| Parameter | Type | Format | Description |
|---|---|---|---|
| ResponseStatus | ResponseStatus | Instance of ResponseStatus object (see here) | |
| Searches | Array | Array of DBSSearchShort objects (see here) | |
| Meta | Meta | Instance of Meta object (see here) |