Sanctions Search API: v2

<back to all web services

GetPdfs

// @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 PdfDocument
{
    /** @description The ID of the saved document */
    // @ApiMember(Description="The ID of the saved document")
    public id: number;

    /** @description Is the document ready to download */
    // @ApiMember(Description="Is the document ready to download")
    public isReady: boolean;

    /** @description The name of the saved document */
    // @ApiMember(Description="The name of the saved document")
    public name: string;

    /** @description The file name (including extension) of the saved document */
    // @ApiMember(Description="The file name (including extension) of the saved document")
    public fileName: string;

    /** @description The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.) */
    // @ApiMember(Description="The type of saved document (Human readable, pep, sanctions, validid, companylookup, etc.)")
    public type: string;

    /** @description If this document is a Saved Sanctions Search, the ID of the search it relates to */
    // @ApiMember(Description="If this document is a Saved Sanctions Search, the ID of the search it relates to")
    public sanctionsSearchId?: number;

    /** @description If this document is a Saved PEP Search, the ID of the search it relates to */
    // @ApiMember(Description="If this document is a Saved PEP Search, the ID of the search it relates to")
    public pepSearchId?: number;

    /** @description If this document is a Saved ValidID Search, the ID of the search it relates to */
    // @ApiMember(Description="If this document is a Saved ValidID Search, the ID of the search it relates to")
    public validIdSearchId?: number;

    /** @description If this document is a Saved CompanyLookup Search, the ID of the search it relates to */
    // @ApiMember(Description="If this document is a Saved CompanyLookup Search, the ID of the search it relates to")
    public companyLookupSearchId?: number;

    /** @description The date the saved document was created/requested */
    // @ApiMember(Description="The date the saved document was created/requested")
    public dateCreated: string;

    /** @description The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods */
    // @ApiMember(Description="The date the saved document will be no longer available. You can request a new document using the SaveSearch, SavePepSearch, etc. methods")
    public dateExpires: string;

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

export class ArrayOfPdfDocument extends Array<PdfDocument>
{

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

export class GetPdfsData extends BaseResponse
{
    /** @description List of Documents, but not including the file data */
    // @ApiMember(Description="List of Documents, but not including the file data")
    public documents: ArrayOfPdfDocument;

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

// @DataContract
export class GetPdfsResponse
{
    /** @description The response data */
    // @DataMember
    // @ApiMember(Description="The response data")
    public data: GetPdfsData;

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

export class GetPdfsRequest
{
    /** @description If the saved documents are kept within a single Sub User account, specify their username here */
    // @ApiMember(Description="If the saved documents are kept within a single Sub User account, specify their username here")
    public subUserName: string;

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

// @DataContract
export class GetPdfs extends BaseRequest
{
    /** @description The request data */
    // @DataMember
    // @ApiMember(Description="The request data", ParameterType="body")
    public request: GetPdfsRequest;

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

TypeScript GetPdfs DTOs

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

{"request":{"subUserName":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"documents":[{"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"}}}}