Sanctions Search API: v2

<back to all web services

CountIncompleteClients

"use strict";
export class Authentication {
    /** @param {{apiUserId?:string,apiUserKey?:string,userId?: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. Can be provided in the request body, or as a header parameter (X-Api-User) */
    apiUserId;
    /**
     * @type {string}
     * @description The API User Key provided by us when you signed up to use our API. Can be provided in the request body, or as a header parameter (X-Api-Key) */
    apiUserKey;
    /**
     * @type {string}
     * @description The User ID of the user making the request (e.g. a sub user). This is optional but can be used to associate API requests with a specific user, thereby allowing user permissions to be enforced. Can be provided in the body, or as a header parameter (X-User-Id). */
    userId;
}
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 CountIncompleteClientsData extends BaseResponse {
    /** @param {{numberOfIncompleteClients?:number,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    numberOfIncompleteClients;
}
export class CountIncompleteClientsResponse {
    /** @param {{data?:CountIncompleteClientsData}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CountIncompleteClientsData} */
    data;
}
/** @typedef {'Undefined'|'PendingCompletion'|'PendingOcr'|'PendingVerification'|'Verified'} */
export var ClientState;
(function (ClientState) {
    ClientState["Undefined"] = "Undefined"
    ClientState["PendingCompletion"] = "PendingCompletion"
    ClientState["PendingOcr"] = "PendingOcr"
    ClientState["PendingVerification"] = "PendingVerification"
    ClientState["Verified"] = "Verified"
})(ClientState || (ClientState = {}));
export class CountIncompleteClients extends BaseRequest {
    /** @param {{daysIncomplete?:number,state?:ClientState,isValidateMe?:boolean,authentication?:Authentication}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {number}
     * @description How many days should have elapsed before counting a Client as incomplete (defaults to 7 days).Set to zero to count all incomplete clients */
    daysIncomplete;
    /**
     * @type {ClientState}
     * @description Count clients that match the state specified (only PendingCompletion, or PendingVerification). */
    state;
    /**
     * @type {boolean}
     * @description Count clients that match the IsValidateMe flag specified (defaults to true). */
    isValidateMe;
}

JavaScript CountIncompleteClients DTOs

GET /clients/incomplete/count HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json

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

{"data":{"numberOfIncompleteClients":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}