Sanctions Search API: v2

AddBulkSearch

Bulk Search

The following routes are available for this service:
POST	/bulksearches/create	Create a bulk search

"use strict";
export class Authentication {
    /** @param {{apiUserId?:string,apiUserKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API User ID provided by us when you signed up to use our API */
    apiUserId;
    /**
     * @type {string}
     * @description The API User Key provided by us when you signed up to use our API */
    apiUserKey;
}
export class BaseRequest {
    /** @param {{authentication?:Authentication}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {Authentication}
     * @description The authentication credentials */
    authentication;
}
export class ResponseError {
    /** @param {{errorCode?:string,fieldName?:string,message?:string,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    fieldName;
    /** @type {string} */
    message;
    /** @type {{ [index: string]: string; }} */
    meta;
}
export class ArrayOfResponseError extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseStatus {
    /** @param {{errorCode?:string,message?:string,stackTrace?:string,errors?:ArrayOfResponseError,meta?:{ [index: string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    errorCode;
    /** @type {string} */
    message;
    /** @type {string} */
    stackTrace;
    /** @type {ArrayOfResponseError} */
    errors;
    /** @type {{ [index: string]: string; }} */
    meta;
}
export class BaseResponse {
    /** @param {{responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {ResponseStatus}
     * @description The status of the response */
    responseStatus;
}
export class BulkSearchStatus {
    /** @param {{bulkSearchId?:number,success?:boolean,status?:string,total?:number,message?:string,processed?:number,isPepSearch?:boolean,isSanctionsSearch?:boolean,totalPep?:number,processedPep?:number,totalSanctions?:number,processedSanctions?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    bulkSearchId;
    /** @type {boolean} */
    success;
    /** @type {string} */
    status;
    /** @type {number} */
    total;
    /** @type {string} */
    message;
    /** @type {number} */
    processed;
    /** @type {boolean} */
    isPepSearch;
    /** @type {boolean} */
    isSanctionsSearch;
    /** @type {number} */
    totalPep;
    /** @type {number} */
    processedPep;
    /** @type {number} */
    totalSanctions;
    /** @type {number} */
    processedSanctions;
}
export class AddBulkSearchData extends BaseResponse {
    /** @param {{bulkSearchStatus?:BulkSearchStatus,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {BulkSearchStatus} */
    bulkSearchStatus;
}
export class AddBulkSearchResponse {
    /** @param {{data?:AddBulkSearchData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AddBulkSearchData} */
    data;
}
export class ArrayOfLists extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class AddBulkSearchRequest {
    /** @param {{isSanctionsSearch?:boolean,isPepSearch?:boolean,type?:string,selectedLists?:ArrayOfLists}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    isSanctionsSearch;
    /** @type {boolean} */
    isPepSearch;
    /** @type {string} */
    type;
    /** @type {ArrayOfLists} */
    selectedLists;
}
export class AddBulkSearch extends BaseRequest {
    /** @param {{request?:AddBulkSearchRequest,authentication?:Authentication}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {AddBulkSearchRequest} */
    request;
}

JavaScript AddBulkSearch 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 /bulksearches/create HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"request":{"isSanctionsSearch":false,"isPepSearch":false,"type":"String","selectedLists":["String"]},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"bulkSearchStatus":{"bulkSearchId":0,"success":false,"status":"String","total":0,"message":"String","processed":0,"isPepSearch":false,"isSanctionsSearch":false,"totalPep":0,"processedPep":0,"totalSanctions":0,"processedSanctions":0},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}