| POST | /clients | Add a client |
|---|
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 LinkedTo() =
member val ClientId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
member val Type:String = null with get,set
member val Subtype:String = null with get,set
member val Status:String = null with get,set
member val Description:String = null with get,set
member val IsArchived:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val Name:String = null with get,set
member val Date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<AllowNullLiteral>]
type ArrayOfLinkedTo() =
inherit ResizeArray<LinkedTo>()
[<DataContract(Name="ClientState", Namespace="http://schemas.servicestack.net/types")>]
type ClientState =
| Undefined = 0
| PendingCompletion = 1
| PendingOcr = 2
| PendingVerification = 3
| Verified = 4
[<AllowNullLiteral>]
type Face() =
member val Age:Nullable<Double> = new Nullable<Double>() with get,set
member val Gender:String = null with get,set
member val Emotion:String = null with get,set
member val Smile:Nullable<Double> = new Nullable<Double>() with get,set
member val HairColour:String = null with get,set
member val FacialHair:String = null with get,set
member val Makeup:String = null with get,set
member val Glasses:String = null with get,set
member val Accessories:String = null with get,set
[<AllowNullLiteral>]
type VideoTimestamp() =
member val TagName:String = null with get,set
member val Milli:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ImageUrl:String = null with get,set
[<AllowNullLiteral>]
type Video() =
member val Id:Int32 = new Int32() with get,set
member val VideoUrl:String = null with get,set
member val ImageUrl:String = null with get,set
member val VideoTimestamps:ResizeArray<VideoTimestamp> = new ResizeArray<VideoTimestamp>() with get,set
[<AllowNullLiteral>]
type Location() =
member val Latitude:Double = new Double() with get,set
member val Longitude:Double = new Double() with get,set
[<AllowNullLiteral>]
type Image() =
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val OcrId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Url:String = null with get,set
[<AllowNullLiteral>]
type ArrayOfImages() =
inherit ResizeArray<Image>()
[<AllowNullLiteral>]
type PassportChipData() =
member val IsIssuerVerified:Boolean = new Boolean() with get,set
member val IssuerCommonName:String = null with get,set
member val IssuerOrganisationName:String = null with get,set
member val IssuerCountry:String = null with get,set
member val MRZLine1:String = null with get,set
member val MRZLine2:String = null with get,set
member val IsMrzLine1Verified:Boolean = new Boolean() with get,set
member val IsMrzLine2Verified:Boolean = new Boolean() with get,set
member val DataGroupsVerified:Int32[] = [||] with get,set
member val DataGroupsFailed:Int32[] = [||] with get,set
member val IsFaceMatch:Boolean = new Boolean() with get,set
member val FaceMatchConfidence:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<AllowNullLiteral>]
type Passport() =
member val ClientFileId:Int32 = new Int32() with get,set
member val FirstName:String = null with get,set
member val MiddleName:String = null with get,set
member val LastName:String = null with get,set
member val DateOfBirth:String = null with get,set
member val Gender:String = null with get,set
member val MrzLineOne:String = null with get,set
member val MrzLineTwo1:String = null with get,set
member val MrzLineTwo2:String = null with get,set
member val MrzLineTwo3:String = null with get,set
member val MrzLineTwo4:String = null with get,set
member val MrzLineTwo5:String = null with get,set
member val MrzLineTwo6:String = null with get,set
member val MrzLineTwo7:String = null with get,set
member val MrzLineTwo8:String = null with get,set
member val Images:ArrayOfImages = null with get,set
member val IsVerified:Boolean = new Boolean() with get,set
member val IsFaceMatch:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val FaceMatchConfidence:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val HasPcvSearch:Boolean = new Boolean() with get,set
member val HasDfaSearch:Boolean = new Boolean() with get,set
member val IsPassportChipVerified:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val PassportChipData:PassportChipData = null with get,set
member val IsEligibleForPcv:Boolean = new Boolean() with get,set
member val IsEligibleForDfa:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type ArrayOfPassports() =
inherit ResizeArray<Passport>()
[<AllowNullLiteral>]
type DrivingLicence() =
member val ClientFileId:Int32 = new Int32() with get,set
member val FirstName:String = null with get,set
member val MiddleName:String = null with get,set
member val LastName:String = null with get,set
member val DateOfBirth:String = null with get,set
member val Address:String = null with get,set
member val DrivingLicenceNumber:String = null with get,set
member val Images:ArrayOfImages = null with get,set
member val IsVerified:Boolean = new Boolean() with get,set
member val IsFaceMatch:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val FaceMatchConfidence:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val HasDfaSearch:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type ArrayOfDrivingLicences() =
inherit ResizeArray<DrivingLicence>()
[<AllowNullLiteral>]
type OtherDocument() =
member val ClientFileId:Int32 = new Int32() with get,set
member val Type:String = null with get,set
member val TypeOther:String = null with get,set
member val Description:String = null with get,set
member val OriginalImageUrl:String = null with get,set
member val CroppedImageUrl:String = null with get,set
member val IsVerified:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type ArrayOfOtherDocuments() =
inherit ResizeArray<OtherDocument>()
[<AllowNullLiteral>]
type ProofOfDocument() =
///<summary>
///The ID of the ProofOfDocument
///</summary>
[<ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true)>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The name of the ProofOfDocument
///</summary>
[<ApiMember(Description="The name of the ProofOfDocument", IsRequired=true)>]
member val Name:String = null with get,set
[<AllowNullLiteral>]
type ArrayOfProofOfDocuments() =
inherit ResizeArray<ProofOfDocument>()
[<AllowNullLiteral>]
type ProofOfDocumentCategory() =
///<summary>
///The ID of the ProofOfDocumentCategory
///</summary>
[<ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true)>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')
///</summary>
[<ApiMember(Description="The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')", IsRequired=true)>]
member val ProofOf:String = null with get,set
///<summary>
///The documents that can be used to provide proof for the specified category.
///</summary>
[<ApiMember(Description="The documents that can be used to provide proof for the specified category.", IsRequired=true)>]
member val ProofOfDocuments:ArrayOfProofOfDocuments = null with get,set
[<AllowNullLiteral>]
type ArrayOfProofOfDocumentCategories() =
inherit ResizeArray<ProofOfDocumentCategory>()
[<AllowNullLiteral>]
type Client() =
member val Id:Int32 = new Int32() with get,set
member val DateCreated:DateTime = new DateTime() with get,set
member val Name:String = null with get,set
member val Email:String = null with get,set
member val Reference:String = null with get,set
member val State:ClientState = new ClientState() with get,set
member val MobileInternational:String = null with get,set
member val PostCode:String = null with get,set
member val IsValidateMe:Boolean = new Boolean() with get,set
member val Face:Face = null with get,set
member val Video:Video = null with get,set
member val Location:Location = null with get,set
member val NumOfDocuments:Int32 = new Int32() with get,set
member val Passports:ArrayOfPassports = null with get,set
member val DrivingLicences:ArrayOfDrivingLicences = null with get,set
member val OtherDocuments:ArrayOfOtherDocuments = null with get,set
member val ProofOfDocumentCategories:ArrayOfProofOfDocumentCategories = null with get,set
[<AllowNullLiteral>]
type AddClientData() =
inherit BaseResponse()
member val LinkedTo:ArrayOfLinkedTo = null with get,set
member val Client:Client = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type AddClientResponse() =
[<DataMember>]
member val Data:AddClientData = 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
[<DataContract(Name="CreateMobileClientType", Namespace="http://schemas.servicestack.net/types")>]
type CreateMobileClientType =
| Undefined = 0
| ValidateMe = 1
| PassportChipVerification = 2
[<AllowNullLiteral>]
type AddClientRequest() =
///<summary>
///The full name of the client
///</summary>
[<ApiMember(Description="The full name of the client", IsRequired=true)>]
member val Name:String = null with get,set
///<summary>
///The email address of the client
///</summary>
[<ApiMember(Description="The email address of the client", IsRequired=true)>]
member val Email:String = null with get,set
///<summary>
///The client's mobile phone number in international format (e.g. '+447123456789')
///</summary>
[<ApiMember(Description="The client's mobile phone number in international format (e.g. '+447123456789')", IsRequired=true)>]
member val MobileInternational:String = null with get,set
///<summary>
///The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine
///</summary>
[<ApiMember(Description="The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine", IsRequired=true)>]
member val PostCode:String = null with get,set
///<summary>
///Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name
///</summary>
[<ApiMember(Description="Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name", IsRequired=true)>]
member val ProofOfPreset:CreateMobileClientType = new CreateMobileClientType() with get,set
///<summary>
///The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'
///</summary>
[<ApiMember(Description="The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'")>]
member val ProofOfDocumentCategories:ArrayOfProofOfDocumentCategories = null with get,set
///<summary>
///If the client should be linked to other searches, specify the them here
///</summary>
[<ApiMember(Description="If the client should be linked to other searches, specify the them here")>]
member val LinkedTo:ArrayOfLinkedTo = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type AddClient() =
inherit BaseRequest()
[<DataMember>]
member val Request:AddClientRequest = null with get,set
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /clients HTTP/1.1
Host: api.sanctionssearch.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"request":{"name":"String","email":"String","mobileInternational":"String","postCode":"String","proofOfPreset":"Undefined","proofOfDocumentCategories":[{"id":0,"proofOf":"String","proofOfDocuments":[{"id":0,"name":"String"}]}],"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}]},"authentication":{"apiUserId":"String","apiUserKey":"String"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"data":{"linkedTo":[{"clientId":0,"id":0,"type":"String","subtype":"String","status":"String","description":"String","isArchived":false,"name":"String","date":"\/Date(-62135596800000-0000)\/"}],"client":{"id":0,"dateCreated":"\/Date(-62135596800000-0000)\/","name":"String","email":"String","reference":"String","state":"Undefined","mobileInternational":"String","postCode":"String","isValidateMe":false,"face":{"age":0,"gender":"String","emotion":"String","smile":0,"hairColour":"String","facialHair":"String","makeup":"String","glasses":"String","accessories":"String"},"video":{"id":0,"videoUrl":"String","imageUrl":"String","videoTimestamps":[{"tagName":"String","milli":0,"imageUrl":"String"}]},"location":{"latitude":0,"longitude":0},"numOfDocuments":0,"passports":[{"clientFileId":0,"firstName":"String","middleName":"String","lastName":"String","dateOfBirth":"String","gender":"String","mrzLineOne":"String","mrzLineTwo1":"String","mrzLineTwo2":"String","mrzLineTwo3":"String","mrzLineTwo4":"String","mrzLineTwo5":"String","mrzLineTwo6":"String","mrzLineTwo7":"String","mrzLineTwo8":"String","images":[{"id":0,"name":"String","ocrId":0,"url":"String"}],"isVerified":false,"isFaceMatch":false,"faceMatchConfidence":0,"hasPcvSearch":false,"hasDfaSearch":false,"isPassportChipVerified":false,"passportChipData":{"isIssuerVerified":false,"issuerCommonName":"String","issuerOrganisationName":"String","issuerCountry":"String","mrzLine1":"String","mrzLine2":"String","isMrzLine1Verified":false,"isMrzLine2Verified":false,"dataGroupsVerified":[0],"dataGroupsFailed":[0],"isFaceMatch":false,"faceMatchConfidence":0},"isEligibleForPcv":false,"isEligibleForDfa":false}],"drivingLicences":[{"clientFileId":0,"firstName":"String","middleName":"String","lastName":"String","dateOfBirth":"String","address":"String","drivingLicenceNumber":"String","images":[{"id":0,"name":"String","ocrId":0,"url":"String"}],"isVerified":false,"isFaceMatch":false,"faceMatchConfidence":0,"hasDfaSearch":false}],"otherDocuments":[{"clientFileId":0,"type":"String","typeOther":"String","description":"String","originalImageUrl":"String","croppedImageUrl":"String","isVerified":false}],"proofOfDocumentCategories":[{"id":0,"proofOf":"String","proofOfDocuments":[{"id":0,"name":"String"}]}]},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}}