Sanctions Search API: v2

ActivateValidId

ValidID

The following routes are available for this service:
POST	/validid/activate	Activate ValidID

namespace SanctionsSearch.Api2.ServiceModel.Operations.Base

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseError() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val FieldName:String = null with get,set

        [<DataMember(Order=3)>]
        member val Message:String = null with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type ArrayOfResponseError() = 
        inherit ResizeArray<ResponseError>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type ResponseStatus() = 
        [<DataMember(Order=1)>]
        member val ErrorCode:String = null with get,set

        [<DataMember(Order=2)>]
        member val Message:String = null with get,set

        [<DataMember(Order=3)>]
        member val StackTrace:String = null with get,set

        [<DataMember(Order=4)>]
        member val Errors:ArrayOfResponseError = null with get,set

        [<DataMember(Order=5)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///The status of the response
        ///</summary>
        [<ApiMember(Description="The status of the response")>]
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type ActivateValidIdData() = 
        inherit BaseResponse()
        member val ValidIdActivated:Boolean = new Boolean() with get,set
        member val AgreementText:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ActivateValidIdResponse() = 
        [<DataMember>]
        member val Data:ActivateValidIdData = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Authentication() = 
        ///<summary>
        ///The API User ID provided by us when you signed up to use our API
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The API User ID provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")>]
        member val ApiUserId:String = null with get,set

        ///<summary>
        ///The API User Key provided by us when you signed up to use our API
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The API User Key provided by us when you signed up to use our API", IsRequired=true, ParameterType="header, body")>]
        member val ApiUserKey:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///The authentication credentials
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body")>]
        member val Authentication:Authentication = null with get,set

    [<AllowNullLiteral>]
    type ActivateValidIdRequest() = 
        member val CompanyName:String = null with get,set
        member val CompanyAddress:String = null with get,set
        member val CompanyNumber:String = null with get,set
        member val Name:String = null with get,set
        member val Position:String = null with get,set
        member val Signature:String = null with get,set
        member val DPANumber:String = null with get,set
        member val AMLBodyNumber:String = null with get,set
        member val Purpose:String = null with get,set
        member val ClassificationId:Int32 = new Int32() with get,set
        member val AgreeToTerms:Boolean = new Boolean() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ActivateValidId() = 
        inherit BaseRequest()
        [<DataMember>]
        member val Request:ActivateValidIdRequest = null with get,set

F# ActivateValidId 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 /validid/activate HTTP/1.1 
Host: api.sanctionssearch.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ActivateValidId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Authentication>
    <ApiUserId>String</ApiUserId>
    <ApiUserKey>String</ApiUserKey>
  </Authentication>
  <Request>
    <AMLBodyNumber>String</AMLBodyNumber>
    <AgreeToTerms>false</AgreeToTerms>
    <ClassificationId>0</ClassificationId>
    <CompanyAddress>String</CompanyAddress>
    <CompanyName>String</CompanyName>
    <CompanyNumber>String</CompanyNumber>
    <DPANumber>String</DPANumber>
    <Name>String</Name>
    <Position>String</Position>
    <Purpose>String</Purpose>
    <Signature>String</Signature>
  </Request>
</ActivateValidId>

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

<ActivateValidIdResponse 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>
    <AgreementText>String</AgreementText>
    <ValidIdActivated>false</ValidIdActivated>
  </Data>
</ActivateValidIdResponse>