Sanctions Search API: v2

<back to all web services

AddDbsSearch

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

// @DataContract
export class Authentication
{
    /** @description 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) */
    // @DataMember
    // @ApiMember(Description="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)", IsRequired=true, ParameterType="header, body")
    public apiUserId: string;

    /** @description 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) */
    // @DataMember
    // @ApiMember(Description="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)", IsRequired=true, ParameterType="header, body")
    public apiUserKey: string;

    /** @description 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). */
    // @DataMember
    // @ApiMember(Description="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).", ParameterType="header, body")
    public userId: string;

    public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseRequest implements IBaseRequest
{
    /** @description The authentication credentials */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public authentication: Authentication;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseError
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public fieldName: string;

    // @DataMember(Order=3)
    public message: string;

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseError>) { (Object as any).assign(this, init); }
}

export class ArrayOfResponseError extends Array<ResponseError>
{

    public constructor(init?: Partial<ArrayOfResponseError>) { super(); (Object as any).assign(this, init); }
}

// @DataContract
export class ResponseStatus
{
    // @DataMember(Order=1)
    public errorCode: string;

    // @DataMember(Order=2)
    public message: string;

    // @DataMember(Order=3)
    public stackTrace: string;

    // @DataMember(Order=4)
    public errors: ArrayOfResponseError;

    // @DataMember(Order=5)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<ResponseStatus>) { (Object as any).assign(this, init); }
}

export class BaseResponse implements IBaseDataResponse, IHasResponseStatus
{
    /** @description The status of the response */
    // @ApiMember(Description="The status of the response")
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

export class LinkedTo
{
    public clientId?: number;
    public id?: number;
    public type?: string;
    public subtype?: string;
    public status?: string;
    public description?: string;
    public isArchived?: boolean;
    public name?: string;
    public date?: string;

    public constructor(init?: Partial<LinkedTo>) { (Object as any).assign(this, init); }
}

export class ArrayOfLinkedTo extends Array<LinkedTo>
{

    public constructor(init?: Partial<ArrayOfLinkedTo>) { super(); (Object as any).assign(this, init); }
}

export class ApplicantInformation
{
    public name: string;
    public dateOfBirth: string;
    public email: string;
    public mobileInternational: string;
    public jobLocation: string;
    public reference: string;
    public applicantPin: string;

    public constructor(init?: Partial<ApplicantInformation>) { (Object as any).assign(this, init); }
}

export class DbsSearchSummary
{
    public id: number;
    public dateSearched: string;
    public dateUpdated: string;
    public status: string;
    public disclosureStatus: string;
    public isApplicantInfoCompleted: boolean;
    public isIdCheckCompleted: boolean;
    public isApplicationCompleted: boolean;
    public isApplicationSubmitted: boolean;
    public isApplicationDisclosed: boolean;
    public disclosureLevel: string;
    public applicantInformation: ApplicantInformation;

    public constructor(init?: Partial<DbsSearchSummary>) { (Object as any).assign(this, init); }
}

export class AddDbsSearchData extends BaseResponse implements IBaseSearchResponse
{
    public linkedTo: ArrayOfLinkedTo;
    public summary: DbsSearchSummary;

    public constructor(init?: Partial<AddDbsSearchData>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class AddDbsSearchResponse
{
    // @DataMember
    public data: AddDbsSearchData;

    public constructor(init?: Partial<AddDbsSearchResponse>) { (Object as any).assign(this, init); }
}

export class AddDbsSearchRequest
{
    /** @description The full name of the applicant */
    // @ApiMember(Description="The full name of the applicant", IsRequired=true)
    public name: string;

    /** @description The date of birth for the applicant (DD/MM/YYYY format) */
    // @ApiMember(Description="The date of birth for the applicant (DD/MM/YYYY format)", IsRequired=true)
    public dateOfBirth: string;

    /** @description The email address of the applicant */
    // @ApiMember(Description="The email address of the applicant", IsRequired=true)
    public email: string;

    /** @description The applicant's mobile phone number in international format (e.g. '+447123456789') */
    // @ApiMember(Description="The applicant's mobile phone number in international format (e.g. '+447123456789')", IsRequired=true)
    public mobileInternational: string;

    /** @description The country where the job is located */
    // @ApiMember(Description="The country where the job is located", IsRequired=true)
    public jobLocation: string;

    /** @description The disclosure level of the DBS required */
    // @ApiMember(Description="The disclosure level of the DBS required", IsRequired=true)
    public disclosureLevel: string;

    /** @description Your reference, if any */
    // @ApiMember(Description="Your reference, if any")
    public reference: string;

    /** @description If this is specified, the search will be created for the specified sub user, otherwise it will be created in the main user account */
    // @ApiMember(Description="If this is specified, the search will be created for the specified sub user, otherwise it will be created in the main user account")
    public subUserName: string;

    /** @description If the search should be linked to other searches, specify the them here */
    // @ApiMember(Description="If the search should be linked to other searches, specify the them here")
    public linkedTo: ArrayOfLinkedTo;

    public constructor(init?: Partial<AddDbsSearchRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class AddDbsSearch extends BaseRequest
{
    // @DataMember
    public request: AddDbsSearchRequest;

    public constructor(init?: Partial<AddDbsSearch>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AddDbsSearch DTOs

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>