Sanctions Search API: v2

<back to all web services

GetValidIds

ValidID
The following routes are available for this service:
POST/validid/listGet all the ValidID Searches
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @DataContract
class Authentication implements JsonSerializable
{
    public function __construct(
        /** @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")
        /** @var string */
        public string $apiUserId='',

        /** @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")
        /** @var string */
        public string $apiUserKey=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['apiUserId'])) $this->apiUserId = $o['apiUserId'];
        if (isset($o['apiUserKey'])) $this->apiUserKey = $o['apiUserKey'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->apiUserId)) $o['apiUserId'] = $this->apiUserId;
        if (isset($this->apiUserKey)) $o['apiUserKey'] = $this->apiUserKey;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class BaseRequest implements IBaseRequest, JsonSerializable
{
    public function __construct(
        /** @description The authentication credentials */
        // @DataMember
        // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
        /** @var Authentication|null */
        public ?Authentication $authentication=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['authentication'])) $this->authentication = JsonConverters::from('Authentication', $o['authentication']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->authentication)) $o['authentication'] = JsonConverters::to('Authentication', $this->authentication);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class ResponseError implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var string|null */
        public ?string $errorCode=null,

        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $fieldName=null,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $message=null,

        // @DataMember(Order=4)
        /** @var array<string,string>|null */
        public ?array $meta=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['errorCode'])) $this->errorCode = $o['errorCode'];
        if (isset($o['fieldName'])) $this->fieldName = $o['fieldName'];
        if (isset($o['message'])) $this->message = $o['message'];
        if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->errorCode)) $o['errorCode'] = $this->errorCode;
        if (isset($this->fieldName)) $o['fieldName'] = $this->fieldName;
        if (isset($this->message)) $o['message'] = $this->message;
        if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
        return empty($o) ? new class(){} : $o;
    }
}

/**
 * @template array of ResponseError
 */
class ArrayOfResponseError extends \ArrayObject implements JsonSerializable
{
    public function __construct(ResponseError ...$items) {
        parent::__construct($items, \ArrayObject::STD_PROP_LIST);
    }
    
    /** @throws \Exception */
    public function append($value): void {
        if ($value instanceof ResponseError)
            parent::append($value);
        else
            throw new \Exception("Can only append a ResponseError to " . __CLASS__);
    }
    
    /** @throws Exception */
    public function fromMap($o): void {
        foreach ($o as $item) {
            $el = new ResponseError();
            $el->fromMap($item);
            $this->append($el);
        }
    }
    
    /** @throws Exception */
    public function jsonSerialize(): array {
        return parent::getArrayCopy();
    }
}

// @DataContract
class ResponseStatus implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var string|null */
        public ?string $errorCode=null,

        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $message=null,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $stackTrace=null,

        // @DataMember(Order=4)
        /** @var ArrayOfResponseError|null */
        public ?ArrayOfResponseError $errors=null,

        // @DataMember(Order=5)
        /** @var array<string,string>|null */
        public ?array $meta=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['errorCode'])) $this->errorCode = $o['errorCode'];
        if (isset($o['message'])) $this->message = $o['message'];
        if (isset($o['stackTrace'])) $this->stackTrace = $o['stackTrace'];
        if (isset($o['errors'])) $this->errors = JsonConverters::from('ArrayOfResponseError', $o['errors']);
        if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->errorCode)) $o['errorCode'] = $this->errorCode;
        if (isset($this->message)) $o['message'] = $this->message;
        if (isset($this->stackTrace)) $o['stackTrace'] = $this->stackTrace;
        if (isset($this->errors)) $o['errors'] = JsonConverters::to('ArrayOfResponseError', $this->errors);
        if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
        return empty($o) ? new class(){} : $o;
    }
}

class BaseResponse implements IBaseDataResponse, IHasResponseStatus, JsonSerializable
{
    public function __construct(
        /** @description The status of the response */
        // @ApiMember(Description="The status of the response")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class ValidIdSearchCriteria implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $fullName=null,
        /** @var DateTime */
        public DateTime $dateOfBirth=new DateTime(),
        /** @var string|null */
        public ?string $gender=null,
        /** @var string|null */
        public ?string $address=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['fullName'])) $this->fullName = $o['fullName'];
        if (isset($o['dateOfBirth'])) $this->dateOfBirth = JsonConverters::from('DateTime', $o['dateOfBirth']);
        if (isset($o['gender'])) $this->gender = $o['gender'];
        if (isset($o['address'])) $this->address = $o['address'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->fullName)) $o['fullName'] = $this->fullName;
        if (isset($this->dateOfBirth)) $o['dateOfBirth'] = JsonConverters::to('DateTime', $this->dateOfBirth);
        if (isset($this->gender)) $o['gender'] = $this->gender;
        if (isset($this->address)) $o['address'] = $this->address;
        return empty($o) ? new class(){} : $o;
    }
}

class ValidIdListItem implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $id=0,
        /** @var int */
        public int $type=0,
        /** @var int|null */
        public ?int $score=null,
        /** @var string|null */
        public ?string $status=null,
        /** @var DateTime */
        public DateTime $dateSearched=new DateTime(),
        /** @var string|null */
        public ?string $reference=null,
        /** @var bool|null */
        public ?bool $pepError=null,
        /** @var bool|null */
        public ?bool $replaced=null,
        /** @var int|null */
        public ?int $replacementSearchId=null,
        /** @var bool|null */
        public ?bool $hasCompletedRequest=null,
        /** @var bool|null */
        public ?bool $hasCompletedSearch=null,
        /** @var ValidIdSearchCriteria|null */
        public ?ValidIdSearchCriteria $searchCriteria=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['id'])) $this->id = $o['id'];
        if (isset($o['type'])) $this->type = $o['type'];
        if (isset($o['score'])) $this->score = $o['score'];
        if (isset($o['status'])) $this->status = $o['status'];
        if (isset($o['dateSearched'])) $this->dateSearched = JsonConverters::from('DateTime', $o['dateSearched']);
        if (isset($o['reference'])) $this->reference = $o['reference'];
        if (isset($o['pepError'])) $this->pepError = $o['pepError'];
        if (isset($o['replaced'])) $this->replaced = $o['replaced'];
        if (isset($o['replacementSearchId'])) $this->replacementSearchId = $o['replacementSearchId'];
        if (isset($o['hasCompletedRequest'])) $this->hasCompletedRequest = $o['hasCompletedRequest'];
        if (isset($o['hasCompletedSearch'])) $this->hasCompletedSearch = $o['hasCompletedSearch'];
        if (isset($o['searchCriteria'])) $this->searchCriteria = JsonConverters::from('ValidIdSearchCriteria', $o['searchCriteria']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->id)) $o['id'] = $this->id;
        if (isset($this->type)) $o['type'] = $this->type;
        if (isset($this->score)) $o['score'] = $this->score;
        if (isset($this->status)) $o['status'] = $this->status;
        if (isset($this->dateSearched)) $o['dateSearched'] = JsonConverters::to('DateTime', $this->dateSearched);
        if (isset($this->reference)) $o['reference'] = $this->reference;
        if (isset($this->pepError)) $o['pepError'] = $this->pepError;
        if (isset($this->replaced)) $o['replaced'] = $this->replaced;
        if (isset($this->replacementSearchId)) $o['replacementSearchId'] = $this->replacementSearchId;
        if (isset($this->hasCompletedRequest)) $o['hasCompletedRequest'] = $this->hasCompletedRequest;
        if (isset($this->hasCompletedSearch)) $o['hasCompletedSearch'] = $this->hasCompletedSearch;
        if (isset($this->searchCriteria)) $o['searchCriteria'] = JsonConverters::to('ValidIdSearchCriteria', $this->searchCriteria);
        return empty($o) ? new class(){} : $o;
    }
}

/**
 * @template array of ValidIdListItem
 */
class ArrayOfValidIdListItem extends \ArrayObject implements JsonSerializable
{
    public function __construct(ValidIdListItem ...$items) {
        parent::__construct($items, \ArrayObject::STD_PROP_LIST);
    }
    
    /** @throws \Exception */
    public function append($value): void {
        if ($value instanceof ValidIdListItem)
            parent::append($value);
        else
            throw new \Exception("Can only append a ValidIdListItem to " . __CLASS__);
    }
    
    /** @throws Exception */
    public function fromMap($o): void {
        foreach ($o as $item) {
            $el = new ValidIdListItem();
            $el->fromMap($item);
            $this->append($el);
        }
    }
    
    /** @throws Exception */
    public function jsonSerialize(): array {
        return parent::getArrayCopy();
    }
}

class GetValidIdsData extends BaseResponse implements JsonSerializable
{
    /**
     * @param ResponseStatus|null $responseStatus
     */
    public function __construct(
        ?ResponseStatus $responseStatus=null,
        /** @var int */
        public int $totalSearchRecords=0,
        /** @var int */
        public int $currentPageNum=0,
        /** @var int */
        public int $maxPageNum=0,
        /** @var ArrayOfValidIdListItem|null */
        public ?ArrayOfValidIdListItem $searchRecords=null
    ) {
        parent::__construct($responseStatus);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['totalSearchRecords'])) $this->totalSearchRecords = $o['totalSearchRecords'];
        if (isset($o['currentPageNum'])) $this->currentPageNum = $o['currentPageNum'];
        if (isset($o['maxPageNum'])) $this->maxPageNum = $o['maxPageNum'];
        if (isset($o['searchRecords'])) $this->searchRecords = JsonConverters::from('ArrayOfValidIdListItem', $o['searchRecords']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->totalSearchRecords)) $o['totalSearchRecords'] = $this->totalSearchRecords;
        if (isset($this->currentPageNum)) $o['currentPageNum'] = $this->currentPageNum;
        if (isset($this->maxPageNum)) $o['maxPageNum'] = $this->maxPageNum;
        if (isset($this->searchRecords)) $o['searchRecords'] = JsonConverters::to('ArrayOfValidIdListItem', $this->searchRecords);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetValidIdsResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var GetValidIdsData|null */
        public ?GetValidIdsData $data=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['data'])) $this->data = JsonConverters::from('GetValidIdsData', $o['data']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->data)) $o['data'] = JsonConverters::to('GetValidIdsData', $this->data);
        return empty($o) ? new class(){} : $o;
    }
}

class GetValidIdsRequest implements JsonSerializable
{
    public function __construct(
        /** @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")
        /** @var string|null */
        public ?string $subUserName=null,

        /** @var int */
        public int $page=0,
        /** @var string|null */
        public ?string $sortOrder=null,
        /** @var string|null */
        public ?string $nameSearch=null,
        /** @var string|null */
        public ?string $filterReference=null,
        /** @var string|null */
        public ?string $filterType=null,
        /** @var DateTime|null */
        public ?DateTime $filterDateFrom=null,
        /** @var DateTime|null */
        public ?DateTime $filterDateTo=null,
        /** @description If set, will only return searches created by the user */
        // @ApiMember(Description="If set, will only return searches created by the user")
        /** @var string|null */
        public ?string $filterUserName=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['subUserName'])) $this->subUserName = $o['subUserName'];
        if (isset($o['page'])) $this->page = $o['page'];
        if (isset($o['sortOrder'])) $this->sortOrder = $o['sortOrder'];
        if (isset($o['nameSearch'])) $this->nameSearch = $o['nameSearch'];
        if (isset($o['filterReference'])) $this->filterReference = $o['filterReference'];
        if (isset($o['filterType'])) $this->filterType = $o['filterType'];
        if (isset($o['filterDateFrom'])) $this->filterDateFrom = JsonConverters::from('DateTime', $o['filterDateFrom']);
        if (isset($o['filterDateTo'])) $this->filterDateTo = JsonConverters::from('DateTime', $o['filterDateTo']);
        if (isset($o['filterUserName'])) $this->filterUserName = $o['filterUserName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->subUserName)) $o['subUserName'] = $this->subUserName;
        if (isset($this->page)) $o['page'] = $this->page;
        if (isset($this->sortOrder)) $o['sortOrder'] = $this->sortOrder;
        if (isset($this->nameSearch)) $o['nameSearch'] = $this->nameSearch;
        if (isset($this->filterReference)) $o['filterReference'] = $this->filterReference;
        if (isset($this->filterType)) $o['filterType'] = $this->filterType;
        if (isset($this->filterDateFrom)) $o['filterDateFrom'] = JsonConverters::to('DateTime', $this->filterDateFrom);
        if (isset($this->filterDateTo)) $o['filterDateTo'] = JsonConverters::to('DateTime', $this->filterDateTo);
        if (isset($this->filterUserName)) $o['filterUserName'] = $this->filterUserName;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class GetValidIds extends BaseRequest implements JsonSerializable
{
    /**
     * @param Authentication|null $authentication
     */
    public function __construct(
        ?Authentication $authentication=null,
        // @DataMember
        /** @var GetValidIdsRequest|null */
        public ?GetValidIdsRequest $request=null
    ) {
        parent::__construct($authentication);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['request'])) $this->request = JsonConverters::from('GetValidIdsRequest', $o['request']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->request)) $o['request'] = JsonConverters::to('GetValidIdsRequest', $this->request);
        return empty($o) ? new class(){} : $o;
    }
}

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

<GetValidIds 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>
    <FilterReference>String</FilterReference>
    <FilterType>String</FilterType>
    <FilterUserName>String</FilterUserName>
    <NameSearch>String</NameSearch>
    <Page>0</Page>
    <SortOrder>String</SortOrder>
    <SubUserName>String</SubUserName>
  </Request>
</GetValidIds>

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

<GetValidIdsResponse 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>
        <DateSearched>0001-01-01T00:00:00</DateSearched>
        <HasCompletedRequest>false</HasCompletedRequest>
        <HasCompletedSearch>false</HasCompletedSearch>
        <Id>0</Id>
        <PepError>false</PepError>
        <Reference>String</Reference>
        <Replaced>false</Replaced>
        <ReplacementSearchId>0</ReplacementSearchId>
        <Score>0</Score>
        <SearchCriteria>
          <Address>String</Address>
          <DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
          <FullName>String</FullName>
          <Gender>String</Gender>
        </SearchCriteria>
        <Status>String</Status>
        <Type>0</Type>
      </SearchRecord>
    </SearchRecords>
    <TotalSearchRecords>0</TotalSearchRecords>
  </Data>
</GetValidIdsResponse>