Sanctions Search API: v2

<back to all web services

GetPdfs

Account
The following routes are available for this service:
POST/pdfs/listGet all PDFs

// @DataContract
export class Authentication
{
    /** @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) */
    // @DataMember
    // @ApiMember(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)", IsRequired=true, ParameterType="header, body")
    public apiUserId: 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) */
    // @DataMember
    // @ApiMember(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)", IsRequired=true, ParameterType="header, body")
    public apiUserKey: 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). */
    // @DataMember
    // @ApiMember(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).", ParameterType="header, body")
    public userId: 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;

    /** @description If saved documents for a specific Sanctions Search Id are required, specify the Sanctions Search Id here */
    // @ApiMember(Description="If saved documents for a specific Sanctions Search Id are required, specify the Sanctions Search Id here")
    public sanctionsSearchId?: number;

    /** @description If saved documents for a specific Pep Search Id are required, specify the Pep Search Id here */
    // @ApiMember(Description="If saved documents for a specific Pep Search Id are required, specify the Pep Search Id here")
    public pepSearchId?: number;

    /** @description If saved documents for a specific ValidId Search Id are required, specify the ValidId Search Id here */
    // @ApiMember(Description="If saved documents for a specific ValidId Search Id are required, specify the ValidId Search Id here")
    public validIdSearchId?: number;

    /** @description If saved documents for a specific Company Lookup Search Id are required, specify the Company Lookup Search Id here */
    // @ApiMember(Description="If saved documents for a specific Company Lookup Search Id are required, specify the Company Lookup Search Id here")
    public companyLookupSearchId?: number;

    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")
    public request: GetPdfsRequest;

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

TypeScript GetPdfs DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

<GetPdfs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
    <UserId>String</UserId>
  </Authentication>
  <Request>
    <CompanyLookupSearchId>0</CompanyLookupSearchId>
    <PepSearchId>0</PepSearchId>
    <SanctionsSearchId>0</SanctionsSearchId>
    <SubUserName>String</SubUserName>
    <ValidIdSearchId>0</ValidIdSearchId>
  </Request>
</GetPdfs>

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

<GetPdfsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Data>
    <ResponseStatus>
      <ErrorCode>String</ErrorCode>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
      <Errors>
        <ResponseError>
          <ErrorCode>String</ErrorCode>
          <FieldName>String</FieldName>
          <Message>String</Message>
          <Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </Meta>
        </ResponseError>
      </Errors>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseStatus>
    <Documents>
      <PdfDocument>
        <CompanyLookupSearchId>0</CompanyLookupSearchId>
        <DateCreated>0001-01-01T00:00:00</DateCreated>
        <DateExpires>0001-01-01T00:00:00</DateExpires>
        <FileName>String</FileName>
        <Id>0</Id>
        <IsReady>false</IsReady>
        <Name>String</Name>
        <PepSearchId>0</PepSearchId>
        <SanctionsSearchId>0</SanctionsSearchId>
        <Type>String</Type>
        <ValidIdSearchId>0</ValidIdSearchId>
      </PdfDocument>
    </Documents>
  </Data>
</GetPdfsResponse>