Sanctions Search API: v2

<back to all web services

GetPepSearch

PEP
The following routes are available for this service:
POST/peps/getGet a PEP search

// @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 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 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 PepSearchResultAddress
{
    public addressLine1: string;
    public addressLine2: string;
    public addressLine3: string;
    public addressLine4: string;
    public town: string;
    public county: string;
    public postCode: string;
    public country: string;
    public isoCountry: string;
    public softDelete?: boolean;
    public dateLastUpdated: string;

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

export class PepSearchResultAlias
{
    public forename: string;
    public middleName: string;
    public surname: string;
    public softDelete?: boolean;
    public dateOfSoftDelete?: string;
    public dateLastUpdated: string;
    public title: string;
    public alternateTitle: string;
    public businessName: string;

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

export class PepSearchResultArticleSnippet
{
    public title: string;
    public text: string;
    public adverseTerms: string;

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

export class PepSearchResultArticle
{
    public url: string;
    public originalUrl: string;
    public source: string;
    public dateOfCapture?: string;
    public dateLastUpdated: string;
    public snippets: PepSearchResultArticleSnippet[];

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

export class PepSearchResultIndividualAssociation
{
    public linkDescription: string;
    public softDelete?: boolean;
    public dateLastUpdated: string;
    public fullName: string;

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

export class PepSearchResultBusinessAssociation
{
    public linkDescription: string;
    public softDelete?: boolean;
    public dateLastUpdated: string;
    public businessName: string;

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

export class PepSearchResultNote
{
    public source: string;
    public notes: string;
    public softDelete?: boolean;
    public dateLastUpdated: string;

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

export class PepSearchResultPoliticalPosition
{
    public description: string;
    public from: string;
    public to: string;
    public country: string;
    public softDelete?: boolean;
    public dateLastUpdated: string;

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

export class PepSearchResult
{
    public resultSimilarity: number;
    public resultResolved: boolean;
    public dateLastUpdated: string;
    public resultIsClient: boolean;
    public id: number;
    public type: string;
    public title: string;
    public forename: string;
    public middlename: string;
    public surname: string;
    public softDelete?: boolean;
    public dateOfSoftDelete?: string;
    public dateOfCapture?: string;
    public dateOfBirth?: string;
    public dateOfDeath?: string;
    public yearOfBirth?: number;
    public yearOfDeath?: number;
    public gender: string;
    public homeTelephone: string;
    public businessTelephone: string;
    public mobileTelephone: string;
    public fax: string;
    public email: string;
    public nationality: string;
    public source: string;
    public category: string;
    public picture: string;
    public alternateTitle: string;
    public businessName: string;
    public description: string;
    public telephone: string;
    public website: string;
    public pepTier?: number;
    public addresses: PepSearchResultAddress[];
    public aliases: PepSearchResultAlias[];
    public articles: PepSearchResultArticle[];
    public associations: PepSearchResultIndividualAssociation[];
    public businessAssociations: PepSearchResultBusinessAssociation[];
    public notes: PepSearchResultNote[];
    public politicalPositions: PepSearchResultPoliticalPosition[];

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

export class PepSearchResults
{
    public results: PepSearchResult[];

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

export class PepSearchRecord
{
    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 searchResults: PepSearchResults;

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

export class GetPepSearchData extends BaseResponse implements IBaseSearchResponse
{
    public linkedTo: ArrayOfLinkedTo;
    public searchRecord: PepSearchRecord;

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

// @DataContract
export class GetPepSearchResponse
{
    // @DataMember
    public data: GetPepSearchData;

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

export class GetPepSearchRequest
{
    /** @description If the search was created against a single Sub User account, specify their username here */
    // @ApiMember(Description="If the search was created against a single Sub User account, specify their username here")
    public subUserName: string;

    /** @description If set to true, the response will exclude resolved search results, it will only include unresolved results */
    // @ApiMember(Description="If set to true, the response will exclude resolved search results, it will only include unresolved results")
    public onlyShowUnresolvedResults: boolean;

    public id: number;

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

// @DataContract
export class GetPepSearch extends BaseRequest
{
    // @DataMember
    public request: GetPepSearchRequest;

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

TypeScript GetPepSearch DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /peps/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"subUserName":"String","onlyShowUnresolvedResults":false,"id":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"searchRecord":{"id":0,"searchType":"String","dateSearched":"\/Date(-62135596800000-0000)\/","dateUpdated":"\/Date(-62135596800000-0000)\/","dateRenewal":"\/Date(-62135596800000-0000)\/","dateArchived":"\/Date(-62135596800000-0000)\/","isArchived":false,"numOfResults":0,"clientInResults":false,"clientNotInResults":false,"affectedByUpdate":false,"isDayOneSearch":false,"searchCriteria":{"name":"String","address":"String","country":"String","dateOfBirth":"String","nationality":"String","reference":"String"},"searchResults":{"results":[{"resultSimilarity":0,"resultResolved":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","resultIsClient":false,"id":0,"type":"String","title":"String","forename":"String","middlename":"String","surname":"String","softDelete":false,"dateOfSoftDelete":"\/Date(-62135596800000-0000)\/","dateOfCapture":"\/Date(-62135596800000-0000)\/","dateOfBirth":"\/Date(-62135596800000-0000)\/","dateOfDeath":"\/Date(-62135596800000-0000)\/","yearOfBirth":0,"yearOfDeath":0,"gender":"String","homeTelephone":"String","businessTelephone":"String","mobileTelephone":"String","fax":"String","email":"String","nationality":"String","source":"String","category":"String","picture":"String","alternateTitle":"String","businessName":"String","description":"String","telephone":"String","website":"String","pepTier":0,"addresses":[{"addressLine1":"String","addressLine2":"String","addressLine3":"String","addressLine4":"String","town":"String","county":"String","postCode":"String","country":"String","isoCountry":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}],"aliases":[{"forename":"String","middleName":"String","surname":"String","softDelete":false,"dateOfSoftDelete":"\/Date(-62135596800000-0000)\/","dateLastUpdated":"\/Date(-62135596800000-0000)\/","title":"String","alternateTitle":"String","businessName":"String"}],"articles":[{"url":"String","originalUrl":"String","source":"String","dateOfCapture":"\/Date(-62135596800000-0000)\/","dateLastUpdated":"\/Date(-62135596800000-0000)\/","snippets":[{"title":"String","text":"String","adverseTerms":"String"}]}],"associations":[{"linkDescription":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","fullName":"String"}],"businessAssociations":[{"linkDescription":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/","businessName":"String"}],"notes":[{"source":"String","notes":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}],"politicalPositions":[{"description":"String","from":"String","to":"String","country":"String","softDelete":false,"dateLastUpdated":"\/Date(-62135596800000-0000)\/"}]}]}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}