Sanctions Search API: v2

<back to all web services

GetValidIds

// @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 ValidIdSearchCriteria
{
    public fullName: string;
    public dateOfBirth: string;
    public gender: string;
    public address: string;

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

export class ValidIdListItem
{
    public id: number;
    public type: number;
    public score?: number;
    public status: string;
    public dateSearched: string;
    public reference: string;
    public pepError: boolean;
    public replaced: boolean;
    public replacementSearchId?: number;
    public hasCompletedRequest: boolean;
    public hasCompletedSearch: boolean;
    public searchCriteria: ValidIdSearchCriteria;

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

export class ArrayOfValidIdListItem extends Array<ValidIdListItem>
{

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

export class GetValidIdsData extends BaseResponse
{
    public totalSearchRecords: number;
    public currentPageNum: number;
    public maxPageNum: number;
    public searchRecords: ArrayOfValidIdListItem;

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

// @DataContract
export class GetValidIdsResponse
{
    // @DataMember
    public data: GetValidIdsData;

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

export class GetValidIdsRequest
{
    /** @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 page: number;
    public sortOrder: string;
    public nameSearch: string;
    public filterReference: 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<GetValidIdsRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class GetValidIds extends BaseRequest
{
    // @DataMember
    public request: GetValidIdsRequest;

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

TypeScript GetValidIds DTOs

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

{"request":{"subUserName":"String","page":0,"sortOrder":"String","nameSearch":"String","filterReference":"String","filterType":"String","filterDateFrom":"\/Date(-62135596800000-0000)\/","filterDateTo":"\/Date(-62135596800000-0000)\/","filterUserName":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"totalSearchRecords":0,"currentPageNum":0,"maxPageNum":0,"searchRecords":[{"id":0,"type":0,"score":0,"status":"String","dateSearched":"\/Date(-62135596800000-0000)\/","reference":"String","pepError":false,"replaced":false,"replacementSearchId":0,"hasCompletedRequest":false,"hasCompletedSearch":false,"searchCriteria":{"fullName":"String","dateOfBirth":"\/Date(-62135596800000-0000)\/","gender":"String","address":"String"}}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}