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
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetPepSearch : BaseRequest()
{
    @DataMember
    var request:GetPepSearchRequest? = null
}

@DataContract
open class BaseRequest : IBaseRequest
{
    /**
    * The authentication credentials
    */
    @DataMember
    @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    var authentication:Authentication? = null
}

@DataContract
open class Authentication
{
    /**
    * 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")
    var apiUserId:String? = null

    /**
    * 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")
    var apiUserKey:String? = null
}

open class GetPepSearchRequest
{
    /**
    * 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")
    var subUserName:String? = null

    /**
    * 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")
    var onlyShowUnresolvedResults:Boolean? = null

    var id:Long? = null
}

@DataContract
open class GetPepSearchResponse
{
    @DataMember
    @SerializedName("data") var Data:GetPepSearchData? = null
}

open class GetPepSearchData : BaseResponse(), IBaseSearchResponse
{
    var linkedTo:ArrayOfLinkedTo? = null
    var searchRecord:PepSearchRecord? = null
}

open class BaseResponse : IBaseDataResponse, IHasResponseStatus
{
    /**
    * The status of the response
    */
    @ApiMember(Description="The status of the response")
    var responseStatus:ResponseStatus? = null
}

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

open class ArrayOfLinkedTo : ArrayList<LinkedTo>()
{
}

open class LinkedTo
{
    var clientId:Int? = null
    var id:Long? = null
    @SerializedName("type") var Type:String? = null
    var subtype:String? = null
    var status:String? = null
    var description:String? = null
    var isArchived:Boolean? = null
    var name:String? = null
    var date:Date? = null
}

open class PepSearchRecord
{
    var id:Long? = null
    var searchType:String? = null
    var dateSearched:Date? = null
    var dateUpdated:Date? = null
    var dateRenewal:Date? = null
    var dateArchived:Date? = null
    var isArchived:Boolean? = null
    var numOfResults:Int? = null
    var clientInResults:Boolean? = null
    var clientNotInResults:Boolean? = null
    var affectedByUpdate:Boolean? = null
    var isDayOneSearch:Boolean? = null
    var searchCriteria:SearchCriteria? = null
    var searchResults:PepSearchResults? = null
}

open class SearchCriteria
{
    var name:String? = null
    var address:String? = null
    var country:String? = null
    var dateOfBirth:String? = null
    var nationality:String? = null
    var reference:String? = null
}

open class PepSearchResults
{
    var results:ArrayList<PepSearchResult> = ArrayList<PepSearchResult>()
}

open class PepSearchResult
{
    var resultSimilarity:BigDecimal? = null
    var resultResolved:Boolean? = null
    var dateLastUpdated:Date? = null
    var resultIsClient:Boolean? = null
    var id:Long? = null
    @SerializedName("type") var Type:String? = null
    var title:String? = null
    var forename:String? = null
    var middlename:String? = null
    var surname:String? = null
    var softDelete:Boolean? = null
    var dateOfSoftDelete:Date? = null
    var dateOfCapture:Date? = null
    var dateOfBirth:Date? = null
    var dateOfDeath:Date? = null
    var yearOfBirth:Int? = null
    var yearOfDeath:Int? = null
    var gender:String? = null
    var homeTelephone:String? = null
    var businessTelephone:String? = null
    var mobileTelephone:String? = null
    var fax:String? = null
    var email:String? = null
    var nationality:String? = null
    var source:String? = null
    var category:String? = null
    var picture:String? = null
    var alternateTitle:String? = null
    var businessName:String? = null
    var description:String? = null
    var telephone:String? = null
    var website:String? = null
    var pepTier:Int? = null
    var addresses:ArrayList<PepSearchResultAddress> = ArrayList<PepSearchResultAddress>()
    var aliases:ArrayList<PepSearchResultAlias> = ArrayList<PepSearchResultAlias>()
    var articles:ArrayList<PepSearchResultArticle> = ArrayList<PepSearchResultArticle>()
    var associations:ArrayList<PepSearchResultIndividualAssociation> = ArrayList<PepSearchResultIndividualAssociation>()
    var businessAssociations:ArrayList<PepSearchResultBusinessAssociation> = ArrayList<PepSearchResultBusinessAssociation>()
    var notes:ArrayList<PepSearchResultNote> = ArrayList<PepSearchResultNote>()
    var politicalPositions:ArrayList<PepSearchResultPoliticalPosition> = ArrayList<PepSearchResultPoliticalPosition>()
}

open class PepSearchResultAddress
{
    var addressLine1:String? = null
    var addressLine2:String? = null
    var addressLine3:String? = null
    var addressLine4:String? = null
    var town:String? = null
    var county:String? = null
    var postCode:String? = null
    var country:String? = null
    var isoCountry:String? = null
    var softDelete:Boolean? = null
    var dateLastUpdated:Date? = null
}

open class PepSearchResultAlias
{
    var forename:String? = null
    var middleName:String? = null
    var surname:String? = null
    var softDelete:Boolean? = null
    var dateOfSoftDelete:Date? = null
    var dateLastUpdated:Date? = null
    var title:String? = null
    var alternateTitle:String? = null
    var businessName:String? = null
}

open class PepSearchResultArticle
{
    var url:String? = null
    var originalUrl:String? = null
    var source:String? = null
    var dateOfCapture:Date? = null
    var dateLastUpdated:Date? = null
    var snippets:ArrayList<PepSearchResultArticleSnippet> = ArrayList<PepSearchResultArticleSnippet>()
}

open class PepSearchResultArticleSnippet
{
    var title:String? = null
    var text:String? = null
    var adverseTerms:String? = null
}

open class PepSearchResultIndividualAssociation
{
    var linkDescription:String? = null
    var softDelete:Boolean? = null
    var dateLastUpdated:Date? = null
    var fullName:String? = null
}

open class PepSearchResultBusinessAssociation
{
    var linkDescription:String? = null
    var softDelete:Boolean? = null
    var dateLastUpdated:Date? = null
    var businessName:String? = null
}

open class PepSearchResultNote
{
    var source:String? = null
    var notes:String? = null
    var softDelete:Boolean? = null
    var dateLastUpdated:Date? = null
}

open class PepSearchResultPoliticalPosition
{
    var description:String? = null
    var from:String? = null
    var to:String? = null
    var country:String? = null
    var softDelete:Boolean? = null
    var dateLastUpdated:Date? = null
}

Kotlin 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"}}}}