Sanctions Search API: v2

<back to all web services

GetPdf

Account
The following routes are available for this service:
POST/pdfs/getGet a PDF
import Foundation
import ServiceStack

// @DataContract
public class GetPdf : BaseRequest
{
    /**
    * The request data
    */
    // @DataMember
    // @ApiMember(Description="The request data", ParameterType="body")
    public var request:GetPdfRequest

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case request
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        request = try container.decodeIfPresent(GetPdfRequest.self, forKey: .request)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if request != nil { try container.encode(request, forKey: .request) }
    }
}

// @DataContract
public class BaseRequest : IBaseRequest, Codable
{
    /**
    * The authentication credentials
    */
    // @DataMember
    // @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")
    public var authentication:Authentication

    required public init(){}
}

// @DataContract
public class Authentication : Codable
{
    /**
    * 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 var apiUserId:String

    /**
    * 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 var apiUserKey:String

    required public init(){}
}

public class GetPdfRequest : Codable
{
    /**
    * If the saved document is kept within a single Sub User account, specify their username here
    */
    // @ApiMember(Description="If the saved document is kept within a single Sub User account, specify their username here")
    public var subUserName:String

    /**
    * The ID of the document to retrieve
    */
    // @ApiMember(Description="The ID of the document to retrieve")
    public var id:Int

    required public init(){}
}

// @DataContract
public class GetPdfResponse : Codable
{
    /**
    * The response data
    */
    // @DataMember
    // @ApiMember(Description="The response data")
    public var data:GetPdfData

    required public init(){}
}

public class GetPdfData : BaseResponse
{
    /**
    * The single document that is being returned, including the file data
    */
    // @ApiMember(Description="The single document that is being returned, including the file data")
    public var document:PdfDocumentWithData

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case document
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        document = try container.decodeIfPresent(PdfDocumentWithData.self, forKey: .document)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if document != nil { try container.encode(document, forKey: .document) }
    }
}

public class BaseResponse : IBaseDataResponse, IHasResponseStatus, Codable
{
    /**
    * The status of the response
    */
    // @ApiMember(Description="The status of the response")
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ArrayOfResponseError : List<ResponseError>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class PdfDocumentWithData : PdfDocument
{
    /**
    * The file data in a byte array
    */
    // @ApiMember(Description="The file data in a byte array")
    public var documentBytes:[UInt8] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case documentBytes
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        documentBytes = try container.decodeIfPresent([UInt8].self, forKey: .documentBytes) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if documentBytes.count > 0 { try container.encode(documentBytes, forKey: .documentBytes) }
    }
}

public class PdfDocument : Codable
{
    /**
    * The ID of the saved document
    */
    // @ApiMember(Description="The ID of the saved document")
    public var id:Int

    /**
    * Is the document ready to download
    */
    // @ApiMember(Description="Is the document ready to download")
    public var isReady:Bool

    /**
    * The name of the saved document
    */
    // @ApiMember(Description="The name of the saved document")
    public var name:String

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

    /**
    * 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 var type:String

    /**
    * 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 var sanctionsSearchId:Int?

    /**
    * 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 var pepSearchId:Int?

    /**
    * 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 var validIdSearchId:Int?

    /**
    * 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 var companyLookupSearchId:Int?

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

    /**
    * 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 var dateExpires:Date

    required public init(){}
}

Swift GetPdf 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/get HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetPdf xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <Id>0</Id>
    <SubUserName>String</SubUserName>
  </Request>
</GetPdf>

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

<GetPdfResponse 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>
    <Document>
      <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>
      <DocumentBytes>AA==</DocumentBytes>
    </Document>
  </Data>
</GetPdfResponse>