Sanctions Search API: v2

GetValidIds

ValidID

The following routes are available for this service:
POST	/validid/list	Get all the ValidID Searches

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@DataContract
open class GetValidIds : BaseRequest()
{
    @DataMember
    var request:GetValidIdsRequest? = null
}

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

@DataContract
open class Authentication
{
    /**
    * 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")
    var apiUserId:String? = null

    /**
    * 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")
    var apiUserKey:String? = null
}

open class GetValidIdsRequest
{
    /**
    * If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view
    */
    @ApiMember(Description="If the searches are being accessed by a sub user, specify their username here to only return searches they have permissions to view")
    var subUserName:String? = null

    var page:Int? = null
    var sortOrder:String? = null
    var nameSearch:String? = null
    var filterReference:String? = null
    var filterType:String? = null
    var filterDateFrom:Date? = null
    var filterDateTo:Date? = null
    /**
    * If set, will only return searches created by the user
    */
    @ApiMember(Description="If set, will only return searches created by the user")
    var filterUserName:String? = null
}

@DataContract
open class GetValidIdsResponse
{
    @DataMember
    @SerializedName("data") var Data:GetValidIdsData? = null
}

open class GetValidIdsData : BaseResponse()
{
    var totalSearchRecords:Int? = null
    var currentPageNum:Int? = null
    var maxPageNum:Int? = null
    var searchRecords:ArrayOfValidIdListItem? = null
}

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

open class ArrayOfResponseError : ArrayList<ResponseError>()
{
}

open class ArrayOfValidIdListItem : ArrayList<ValidIdListItem>()
{
}

open class ValidIdListItem
{
    var id:Int? = null
    @SerializedName("type") var Type:Int? = null
    var score:Int? = null
    var status:String? = null
    var dateSearched:Date? = null
    var reference:String? = null
    var pepError:Boolean? = null
    var replaced:Boolean? = null
    var replacementSearchId:Int? = null
    var hasCompletedRequest:Boolean? = null
    var hasCompletedSearch:Boolean? = null
    var searchCriteria:ValidIdSearchCriteria? = null
}

open class ValidIdSearchCriteria
{
    var fullName:String? = null
    var dateOfBirth:Date? = null
    var gender:String? = null
    var address:String? = null
}

Kotlin GetValidIds DTOs

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

HTTP + JSON

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

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

{"request":{"subUserName":"String","page":0,"sortOrder":"String","nameSearch":"String","filterReference":"String","filterType":"String","filterDateFrom":"\/Date(-62135596800000-0000)\/","filterDateTo":"\/Date(-62135596800000-0000)\/","filterUserName":"String"},"authentication":{"apiUserId":"String","apiUserKey":"String"}}

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

{"data":{"totalSearchRecords":0,"currentPageNum":0,"maxPageNum":0,"searchRecords":[{"id":0,"type":0,"score":0,"status":"String","dateSearched":"\/Date(-62135596800000-0000)\/","reference":"String","pepError":false,"replaced":false,"replacementSearchId":0,"hasCompletedRequest":false,"hasCompletedSearch":false,"searchCriteria":{"fullName":"String","dateOfBirth":"\/Date(-62135596800000-0000)\/","gender":"String","address":"String"}}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}