| POST | /pdfs/get | Get a PDF |
|---|
"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 PdfDocument {
/** @param {{id?:number,isReady?:boolean,name?:string,fileName?:string,type?:string,sanctionsSearchId?:number,pepSearchId?:number,validIdSearchId?:number,companyLookupSearchId?:number,dateCreated?:string,dateExpires?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The ID of the saved document */
id;
/**
* @type {boolean}
* @description Is the document ready to download */
isReady;
/**
* @type {string}
* @description The name of the saved document */
name;
/**
* @type {string}
* @description The file name (including extension) of the saved document */
fileName;
/**
* @type {string}
* @description The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.) */
type;
/**
* @type {?number}
* @description If this document is a Saved Sanctions Search, the ID of the search it relates to */
sanctionsSearchId;
/**
* @type {?number}
* @description If this document is a Saved PEP Search, the ID of the search it relates to */
pepSearchId;
/**
* @type {?number}
* @description If this document is a Saved ValidID Search, the ID of the search it relates to */
validIdSearchId;
/**
* @type {?number}
* @description If this document is a Saved CompanyLookup Search, the ID of the search it relates to */
companyLookupSearchId;
/**
* @type {string}
* @description The date the saved document was created/requested */
dateCreated;
/**
* @type {string}
* @description The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods */
dateExpires;
}
export class PdfDocumentWithData extends PdfDocument {
/** @param {{documentBytes?:string,id?:number,isReady?:boolean,name?:string,fileName?:string,type?:string,sanctionsSearchId?:number,pepSearchId?:number,validIdSearchId?:number,companyLookupSearchId?:number,dateCreated?:string,dateExpires?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description The file data in a byte array */
documentBytes;
}
export class GetPdfData extends BaseResponse {
/** @param {{document?:PdfDocumentWithData,responseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {PdfDocumentWithData}
* @description The single document that is being returned, including the file data */
document;
}
export class GetPdfResponse {
/** @param {{data?:GetPdfData}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {GetPdfData}
* @description The response data */
data;
}
export class GetPdfRequest {
/** @param {{subUserName?:string,id?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description If the saved document is kept within a single Sub User account, specify their username here */
subUserName;
/**
* @type {number}
* @description The ID of the document to retrieve */
id;
}
export class GetPdf extends BaseRequest {
/** @param {{request?:GetPdfRequest,authentication?:Authentication}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {GetPdfRequest}
* @description The request data */
request;
}
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /pdfs/get HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"subUserName":"String","id":0},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"document":{"documentBytes":"AA==","id":0,"isReady":false,"name":"String","fileName":"String","type":"String","sanctionsSearchId":0,"pepSearchId":0,"validIdSearchId":0,"companyLookupSearchId":0,"dateCreated":"\/Date(-62135596800000-0000)\/","dateExpires":"\/Date(-62135596800000-0000)\/"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}