Sanctions Search API: v2

AddDbsSearch

DBS

The following routes are available for this service:
POST	/dbs	Add a DBS Search

**AddDbsSearch** Parameters:
Name	Parameter	Data Type	Required	Description
Request	body	AddDbsSearchRequest	No

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Authentication	header, body	Authentication	Yes	The authentication credentials

**Authentication** Parameters:
Name	Parameter	Data Type	Required	Description
ApiUserId	header, body	string	Yes	The API User ID provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-User)
ApiUserKey	header, body	string	Yes	The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key)
UserId	header, body	string	No	The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id).

**AddDbsSearchRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	Yes	The full name of the applicant
DateOfBirth	form	string	Yes	The date of birth for the applicant (DD/MM/YYYY format)
Email	form	string	Yes	The email address of the applicant
MobileInternational	form	string	Yes	The applicant's mobile phone number in international format (e.g. '+447123456789')
JobLocation	form	string	Yes	The country where the job is located
DisclosureLevel	form	string	Yes	The disclosure level of the DBS required
Reference	form	string	No	Your reference, if any
SubUserName	form	string	No	If this is specified, the search will be created for the specified sub user, otherwise it will be created in the main user account
LinkedTo	form	ArrayOfLinkedTo	No	If the search should be linked to other searches, specify the them here

**LinkedTo** Parameters:
Name	Parameter	Data Type	Required
ClientId	form	int?	No
Id	form	long?	No
Type	form	string	No
Subtype	form	string	No
Status	form	string	No
Description	form	string	No
IsArchived	form	bool?	No
Name	form	string	No
Date	form	DateTime?	No

**AddDbsSearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	AddDbsSearchData	No

**AddDbsSearchData** Parameters:
Name	Parameter	Data Type	Required	Description
LinkedTo	form	ArrayOfLinkedTo	No
Summary	form	DbsSearchSummary	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No	The status of the response

**ResponseStatus** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StackTrace	form	string	No
Errors	form	ArrayOfResponseError	No
Meta	form	Dictionary<string, string>	No

**ResponseError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
FieldName	form	string	No
Message	form	string	No
Meta	form	Dictionary<string, string>	No

**DbsSearchSummary** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
DateSearched	form	DateTime	No
DateUpdated	form	DateTime	No
Status	form	string	No
DisclosureStatus	form	string	No
IsApplicantInfoCompleted	form	bool	No
IsIdCheckCompleted	form	bool	No
IsApplicationCompleted	form	bool	No
IsApplicationSubmitted	form	bool	No
IsApplicationDisclosed	form	bool	No
DisclosureLevel	form	string	No
ApplicantInformation	form	ApplicantInformation	No

**ApplicantInformation** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
DateOfBirth	form	string	No
Email	form	string	No
MobileInternational	form	string	No
JobLocation	form	string	No
Reference	form	string	No
ApplicantPin	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /dbs HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddDbsSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
    <UserId>String</UserId>
  </Authentication>
  <Request>
    <DateOfBirth>String</DateOfBirth>
    <DisclosureLevel>String</DisclosureLevel>
    <Email>String</Email>
    <JobLocation>String</JobLocation>
    <LinkedTo>
      <LinkedTo>
        <ClientId>0</ClientId>
        <Date>0001-01-01T00:00:00</Date>
        <Description>String</Description>
        <Id>0</Id>
        <IsArchived>false</IsArchived>
        <Name>String</Name>
        <Status>String</Status>
        <Subtype>String</Subtype>
        <Type>String</Type>
      </LinkedTo>
    </LinkedTo>
    <MobileInternational>String</MobileInternational>
    <Name>String</Name>
    <Reference>String</Reference>
    <SubUserName>String</SubUserName>
  </Request>
</AddDbsSearch>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddDbsSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <LinkedTo>
      <LinkedTo>
        <ClientId>0</ClientId>
        <Date>0001-01-01T00:00:00</Date>
        <Description>String</Description>
        <Id>0</Id>
        <IsArchived>false</IsArchived>
        <Name>String</Name>
        <Status>String</Status>
        <Subtype>String</Subtype>
        <Type>String</Type>
      </LinkedTo>
    </LinkedTo>
    <Summary>
      <ApplicantInformation>
        <ApplicantPin>String</ApplicantPin>
        <DateOfBirth>String</DateOfBirth>
        <Email>String</Email>
        <JobLocation>String</JobLocation>
        <MobileInternational>String</MobileInternational>
        <Name>String</Name>
        <Reference>String</Reference>
      </ApplicantInformation>
      <DateSearched>0001-01-01T00:00:00</DateSearched>
      <DateUpdated>0001-01-01T00:00:00</DateUpdated>
      <DisclosureLevel>String</DisclosureLevel>
      <DisclosureStatus>String</DisclosureStatus>
      <Id>0</Id>
      <IsApplicantInfoCompleted>false</IsApplicantInfoCompleted>
      <IsApplicationCompleted>false</IsApplicationCompleted>
      <IsApplicationDisclosed>false</IsApplicationDisclosed>
      <IsApplicationSubmitted>false</IsApplicationSubmitted>
      <IsIdCheckCompleted>false</IsIdCheckCompleted>
      <Status>String</Status>
    </Summary>
  </Data>
</AddDbsSearchResponse>