Sanctions Search API: v2

<back to all web services

GetPepSearches

PEP
The following routes are available for this service:
POST/peps/listGet all PEP searches

// @DataContract
export class Authentication
{
    /** @description The API User ID provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserId: string;

    /** @description The API User Key provided by us when you signed up to use our API */
    // @DataMember
    // @ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")
    public apiUserKey: 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 SearchCriteria
{
    public name: string;
    public address: string;
    public country: string;
    public dateOfBirth: string;
    public nationality: string;
    public reference: string;

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

export class PepSearchListItem
{
    public id: number;
    public searchType: string;
    public dateSearched: string;
    public dateUpdated: string;
    public dateRenewal?: string;
    public dateArchived?: string;
    public isArchived: boolean;
    public numOfResults: number;
    public clientInResults: boolean;
    public clientNotInResults: boolean;
    public affectedByUpdate: boolean;
    public isDayOneSearch: boolean;
    public searchCriteria: SearchCriteria;

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

export class ArrayOfPepSearchListItem extends Array<PepSearchListItem>
{

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

export class GetPepSearchesData extends BaseResponse
{
    public totalSearchRecords: number;
    public currentPageNum: number;
    public maxPageNum: number;
    public searchRecords: ArrayOfPepSearchListItem;

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

// @DataContract
export class GetPepSearchesResponse
{
    // @DataMember
    public data: GetPepSearchesData;

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

export class GetPepSearchesRequest
{
    /** @description If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view */
    // @ApiMember(Description="If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view")
    public subUserName: string;

    public listUnresolvedSearches?: boolean;
    public listUpdatedSearches?: boolean;
    public listArchivedSearches: boolean;
    public page: number;
    public sortOrder: string;
    public nameSearch: string;
    public nameSearchExact: boolean;
    public filterReference: string;
    public filterPepType: string;
    public filterType: string;
    public filterDateFrom?: string;
    public filterDateTo?: string;
    /** @description If set, will only return searches created by the user */
    // @ApiMember(Description="If set, will only return searches created by the user")
    public filterUserName: string;

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

// @DataContract
export class GetPepSearches extends BaseRequest
{
    // @DataMember
    public request: GetPepSearchesRequest;

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

TypeScript GetPepSearches 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 /peps/list HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPepSearches xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <FilterDateFrom>0001-01-01T00:00:00</FilterDateFrom>
    <FilterDateTo>0001-01-01T00:00:00</FilterDateTo>
    <FilterPepType>String</FilterPepType>
    <FilterReference>String</FilterReference>
    <FilterType>String</FilterType>
    <FilterUserName>String</FilterUserName>
    <ListArchivedSearches>false</ListArchivedSearches>
    <ListUnresolvedSearches>false</ListUnresolvedSearches>
    <ListUpdatedSearches>false</ListUpdatedSearches>
    <NameSearch>String</NameSearch>
    <NameSearchExact>false</NameSearchExact>
    <Page>0</Page>
    <SortOrder>String</SortOrder>
    <SubUserName>String</SubUserName>
  </Request>
</GetPepSearches>

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

<GetPepSearchesResponse 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>
    <CurrentPageNum>0</CurrentPageNum>
    <MaxPageNum>0</MaxPageNum>
    <SearchRecords>
      <SearchRecord>
        <AffectedByUpdate>false</AffectedByUpdate>
        <ClientInResults>false</ClientInResults>
        <ClientNotInResults>false</ClientNotInResults>
        <DateArchived>0001-01-01T00:00:00</DateArchived>
        <DateRenewal>0001-01-01T00:00:00</DateRenewal>
        <DateSearched>0001-01-01T00:00:00</DateSearched>
        <DateUpdated>0001-01-01T00:00:00</DateUpdated>
        <Id>0</Id>
        <IsArchived>false</IsArchived>
        <IsDayOneSearch>false</IsDayOneSearch>
        <NumOfResults>0</NumOfResults>
        <SearchCriteria>
          <Address>String</Address>
          <Country>String</Country>
          <DateOfBirth>String</DateOfBirth>
          <Name>String</Name>
          <Nationality>String</Nationality>
          <Reference>String</Reference>
        </SearchCriteria>
        <SearchType>String</SearchType>
      </SearchRecord>
    </SearchRecords>
    <TotalSearchRecords>0</TotalSearchRecords>
  </Data>
</GetPepSearchesResponse>