Sanctions Search API: v2

<back to all web services

GetClientDocument

import Foundation
import ServiceStack

// @DataContract
public class GetClientDocument : BaseRequest
{
    // @DataMember
    // @ApiMember(IsRequired=true, ParameterType="path")
    public var id:Int

    // @DataMember
    public var original:Bool

    // @DataMember
    public var mil:Int?

    // @DataMember
    public var ocrId:Int?

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

    private enum CodingKeys : String, CodingKey {
        case id
        case original
        case mil
        case ocrId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        original = try container.decodeIfPresent(Bool.self, forKey: .original)
        mil = try container.decodeIfPresent(Int.self, forKey: .mil)
        ocrId = try container.decodeIfPresent(Int.self, forKey: .ocrId)
    }

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

// @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(){}
}

// @DataContract
public class GetClientDocumentResponse : Codable
{
    // @DataMember
    public var data:GetClientDocumentData

    required public init(){}
}

public class GetClientDocumentData : BaseResponse
{
    public var base64Image:String

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

    private enum CodingKeys : String, CodingKey {
        case base64Image
    }

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

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

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)
    }
}

Swift GetClientDocument DTOs

GET /clients/documents/{Id} HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/json

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

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