/* Options: Date: 2025-03-15 03:32:29 Version: 8.30 Tip: To override a DTO option, remove "//" prefix before updating BaseUrl: https://api.sanctionssearch.com/v2 //Package: //GlobalNamespace: dtos //AddPropertyAccessors: True //SettersReturnThis: True //AddServiceStackTypes: True //AddResponseStatus: False //AddDescriptionAsComments: True //AddImplicitVersion: IncludeTypes: AddClient.* //ExcludeTypes: //TreatTypesAsStrings: //DefaultImports: java.math.*,java.util.*,net.servicestack.client.* */ import java.math.*; import java.util.*; import net.servicestack.client.*; public class dtos { @Route(Path="/clients", Verbs="POST") @DataContract public static class AddClient extends BaseRequest implements IReturn { @DataMember public AddClientRequest request = null; public AddClientRequest getRequest() { return request; } public AddClient setRequest(AddClientRequest value) { this.request = value; return this; } private static Object responseType = AddClientResponse.class; public Object getResponseType() { return responseType; } } @DataContract public static class AddClientResponse { @DataMember public AddClientData data = null; public AddClientData getData() { return data; } public AddClientResponse setData(AddClientData value) { this.data = value; return this; } } @DataContract public static 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") public String apiUserId = 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") public String apiUserKey = null; public String getApiUserId() { return apiUserId; } public Authentication setApiUserId(String value) { this.apiUserId = value; return this; } public String getApiUserKey() { return apiUserKey; } public Authentication setApiUserKey(String value) { this.apiUserKey = value; return this; } } @DataContract public static class BaseRequest implements IBaseRequest { /** * The authentication credentials */ @DataMember @ApiMember(Description="The authentication credentials", IsRequired=true, ParameterType="header, body") public Authentication authentication = null; public Authentication getAuthentication() { return authentication; } public BaseRequest setAuthentication(Authentication value) { this.authentication = value; return this; } } public static interface IBaseRequest { public Authentication authentication = null; } public static class AddClientRequest { /** * The full name of the client */ @ApiMember(Description="The full name of the client", IsRequired=true) public String name = null; /** * The email address of the client */ @ApiMember(Description="The email address of the client", IsRequired=true) public String email = null; /** * The client's mobile phone number in international format (e.g. '+447123456789') */ @ApiMember(Description="The client's mobile phone number in international format (e.g. '+447123456789')", IsRequired=true) public String mobileInternational = null; /** * The postal code of the client's address. Used in emails sent to the client to help them recognize the communication as genuine */ @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) public String postCode = null; /** * Specifies the type of ValidateMe preset. Possible values are 'ValidateMe' for configuring RequiredDocuments, or 'PassportChipVerification' for setting the Passport as Proof of Name */ @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) public CreateMobileClientType proofOfPreset = null; /** * The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe' */ @ApiMember(Description="The categories of proof and selected documents that the client can use to provide proof. Required if ClientType is set to 'ValidateMe'") public ArrayOfProofOfDocumentCategories proofOfDocumentCategories = null; /** * If the client should be linked to other searches, specify the them here */ @ApiMember(Description="If the client should be linked to other searches, specify the them here") public ArrayOfLinkedTo linkedTo = null; public String getName() { return name; } public AddClientRequest setName(String value) { this.name = value; return this; } public String getEmail() { return email; } public AddClientRequest setEmail(String value) { this.email = value; return this; } public String getMobileInternational() { return mobileInternational; } public AddClientRequest setMobileInternational(String value) { this.mobileInternational = value; return this; } public String getPostCode() { return postCode; } public AddClientRequest setPostCode(String value) { this.postCode = value; return this; } public CreateMobileClientType getProofOfPreset() { return proofOfPreset; } public AddClientRequest setProofOfPreset(CreateMobileClientType value) { this.proofOfPreset = value; return this; } public ArrayOfProofOfDocumentCategories getProofOfDocumentCategories() { return proofOfDocumentCategories; } public AddClientRequest setProofOfDocumentCategories(ArrayOfProofOfDocumentCategories value) { this.proofOfDocumentCategories = value; return this; } public ArrayOfLinkedTo getLinkedTo() { return linkedTo; } public AddClientRequest setLinkedTo(ArrayOfLinkedTo value) { this.linkedTo = value; return this; } } @DataContract(Name="ClientState", Namespace="http://schemas.servicestack.net/types") public static enum ClientState { Undefined, PendingCompletion, PendingOcr, PendingVerification, Verified; } public static class Client { public Integer id = null; public Date dateCreated = null; public String name = null; public String email = null; public String reference = null; public ClientState state = null; public String mobileInternational = null; public String postCode = null; public Boolean isValidateMe = null; public Face face = null; public Video video = null; public Location location = null; public Integer numOfDocuments = null; public ArrayOfPassports passports = null; public ArrayOfDrivingLicences drivingLicences = null; public ArrayOfOtherDocuments otherDocuments = null; public ArrayOfProofOfDocumentCategories proofOfDocumentCategories = null; public Integer getId() { return id; } public Client setId(Integer value) { this.id = value; return this; } public Date getDateCreated() { return dateCreated; } public Client setDateCreated(Date value) { this.dateCreated = value; return this; } public String getName() { return name; } public Client setName(String value) { this.name = value; return this; } public String getEmail() { return email; } public Client setEmail(String value) { this.email = value; return this; } public String getReference() { return reference; } public Client setReference(String value) { this.reference = value; return this; } public ClientState getState() { return state; } public Client setState(ClientState value) { this.state = value; return this; } public String getMobileInternational() { return mobileInternational; } public Client setMobileInternational(String value) { this.mobileInternational = value; return this; } public String getPostCode() { return postCode; } public Client setPostCode(String value) { this.postCode = value; return this; } public Boolean getIsValidateMe() { return isValidateMe; } public Client setIsValidateMe(Boolean value) { this.isValidateMe = value; return this; } public Face getFace() { return face; } public Client setFace(Face value) { this.face = value; return this; } public Video getVideo() { return video; } public Client setVideo(Video value) { this.video = value; return this; } public Location getLocation() { return location; } public Client setLocation(Location value) { this.location = value; return this; } public Integer getNumOfDocuments() { return numOfDocuments; } public Client setNumOfDocuments(Integer value) { this.numOfDocuments = value; return this; } public ArrayOfPassports getPassports() { return passports; } public Client setPassports(ArrayOfPassports value) { this.passports = value; return this; } public ArrayOfDrivingLicences getDrivingLicences() { return drivingLicences; } public Client setDrivingLicences(ArrayOfDrivingLicences value) { this.drivingLicences = value; return this; } public ArrayOfOtherDocuments getOtherDocuments() { return otherDocuments; } public Client setOtherDocuments(ArrayOfOtherDocuments value) { this.otherDocuments = value; return this; } public ArrayOfProofOfDocumentCategories getProofOfDocumentCategories() { return proofOfDocumentCategories; } public Client setProofOfDocumentCategories(ArrayOfProofOfDocumentCategories value) { this.proofOfDocumentCategories = value; return this; } } public static class AddClientData extends BaseResponse implements IBaseSearchResponse { public ArrayOfLinkedTo linkedTo = null; public Client client = null; public ArrayOfLinkedTo getLinkedTo() { return linkedTo; } public AddClientData setLinkedTo(ArrayOfLinkedTo value) { this.linkedTo = value; return this; } public Client getClient() { return client; } public AddClientData setClient(Client value) { this.client = value; return this; } } public static class ArrayOfProofOfDocumentCategories extends ArrayList { } @DataContract(Name="CreateMobileClientType", Namespace="http://schemas.servicestack.net/types") public static enum CreateMobileClientType { Undefined, ValidateMe, PassportChipVerification; } public static class ArrayOfLinkedTo extends ArrayList { } public static class Face { public Double age = null; public String gender = null; public String emotion = null; public Double smile = null; public String hairColour = null; public String facialHair = null; public String makeup = null; public String glasses = null; public String accessories = null; public Double getAge() { return age; } public Face setAge(Double value) { this.age = value; return this; } public String getGender() { return gender; } public Face setGender(String value) { this.gender = value; return this; } public String getEmotion() { return emotion; } public Face setEmotion(String value) { this.emotion = value; return this; } public Double getSmile() { return smile; } public Face setSmile(Double value) { this.smile = value; return this; } public String getHairColour() { return hairColour; } public Face setHairColour(String value) { this.hairColour = value; return this; } public String getFacialHair() { return facialHair; } public Face setFacialHair(String value) { this.facialHair = value; return this; } public String getMakeup() { return makeup; } public Face setMakeup(String value) { this.makeup = value; return this; } public String getGlasses() { return glasses; } public Face setGlasses(String value) { this.glasses = value; return this; } public String getAccessories() { return accessories; } public Face setAccessories(String value) { this.accessories = value; return this; } } public static class Video { public Integer id = null; public String videoUrl = null; public String imageUrl = null; public ArrayList videoTimestamps = null; public Integer getId() { return id; } public Video setId(Integer value) { this.id = value; return this; } public String getVideoUrl() { return videoUrl; } public Video setVideoUrl(String value) { this.videoUrl = value; return this; } public String getImageUrl() { return imageUrl; } public Video setImageUrl(String value) { this.imageUrl = value; return this; } public ArrayList getVideoTimestamps() { return videoTimestamps; } public Video setVideoTimestamps(ArrayList value) { this.videoTimestamps = value; return this; } } public static class Location { public Double latitude = null; public Double longitude = null; public Double getLatitude() { return latitude; } public Location setLatitude(Double value) { this.latitude = value; return this; } public Double getLongitude() { return longitude; } public Location setLongitude(Double value) { this.longitude = value; return this; } } public static class ArrayOfPassports extends ArrayList { } public static class ArrayOfDrivingLicences extends ArrayList { } public static class ArrayOfOtherDocuments extends ArrayList { } public static class BaseResponse implements IBaseDataResponse, IHasResponseStatus { /** * The status of the response */ @ApiMember(Description="The status of the response") public ResponseStatus responseStatus = null; public ResponseStatus getResponseStatus() { return responseStatus; } public BaseResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; } } public static interface IBaseDataResponse { public ResponseStatus responseStatus = null; } public static interface IHasResponseStatus { public ResponseStatus responseStatus = null; } public static interface IBaseSearchResponse implements IBaseDataResponse { public ArrayOfLinkedTo linkedTo = null; } public static class ProofOfDocumentCategory { /** * The ID of the ProofOfDocumentCategory */ @ApiMember(Description="The ID of the ProofOfDocumentCategory", IsRequired=true) public Integer id = null; /** * The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work') */ @ApiMember(Description="The category or subject that requires proof (e.g., 'Name', 'Address', 'Right to work')", IsRequired=true) public String proofOf = null; /** * The documents that can be used to provide proof for the specified category. */ @ApiMember(Description="The documents that can be used to provide proof for the specified category.", IsRequired=true) public ArrayOfProofOfDocuments proofOfDocuments = null; public Integer getId() { return id; } public ProofOfDocumentCategory setId(Integer value) { this.id = value; return this; } public String getProofOf() { return proofOf; } public ProofOfDocumentCategory setProofOf(String value) { this.proofOf = value; return this; } public ArrayOfProofOfDocuments getProofOfDocuments() { return proofOfDocuments; } public ProofOfDocumentCategory setProofOfDocuments(ArrayOfProofOfDocuments value) { this.proofOfDocuments = value; return this; } } public static class LinkedTo { public Integer clientId = null; public Long id = null; public String type = null; public String subtype = null; public String status = null; public String description = null; public Boolean isArchived = null; public String name = null; public Date date = null; public Integer getClientId() { return clientId; } public LinkedTo setClientId(Integer value) { this.clientId = value; return this; } public Long getId() { return id; } public LinkedTo setId(Long value) { this.id = value; return this; } public String getType() { return type; } public LinkedTo setType(String value) { this.type = value; return this; } public String getSubtype() { return subtype; } public LinkedTo setSubtype(String value) { this.subtype = value; return this; } public String getStatus() { return status; } public LinkedTo setStatus(String value) { this.status = value; return this; } public String getDescription() { return description; } public LinkedTo setDescription(String value) { this.description = value; return this; } public Boolean getIsArchived() { return isArchived; } public LinkedTo setIsArchived(Boolean value) { this.isArchived = value; return this; } public String getName() { return name; } public LinkedTo setName(String value) { this.name = value; return this; } public Date getDate() { return date; } public LinkedTo setDate(Date value) { this.date = value; return this; } } public static class VideoTimestamp { public String tagName = null; public Integer milli = null; public String imageUrl = null; public String getTagName() { return tagName; } public VideoTimestamp setTagName(String value) { this.tagName = value; return this; } public Integer getMilli() { return milli; } public VideoTimestamp setMilli(Integer value) { this.milli = value; return this; } public String getImageUrl() { return imageUrl; } public VideoTimestamp setImageUrl(String value) { this.imageUrl = value; return this; } } public static class Passport { public Integer clientFileId = null; public String firstName = null; public String middleName = null; public String lastName = null; public String dateOfBirth = null; public String gender = null; public String mrzLineOne = null; public String mrzLineTwo1 = null; public String mrzLineTwo2 = null; public String mrzLineTwo3 = null; public String mrzLineTwo4 = null; public String mrzLineTwo5 = null; public String mrzLineTwo6 = null; public String mrzLineTwo7 = null; public String mrzLineTwo8 = null; public ArrayOfImages images = null; public Boolean isVerified = null; public Boolean isFaceMatch = null; public BigDecimal faceMatchConfidence = null; public Boolean hasPcvSearch = null; public Boolean hasDfaSearch = null; public Boolean isPassportChipVerified = null; public PassportChipData passportChipData = null; public Boolean isEligibleForPcv = null; public Boolean isEligibleForDfa = null; public Integer getClientFileId() { return clientFileId; } public Passport setClientFileId(Integer value) { this.clientFileId = value; return this; } public String getFirstName() { return firstName; } public Passport setFirstName(String value) { this.firstName = value; return this; } public String getMiddleName() { return middleName; } public Passport setMiddleName(String value) { this.middleName = value; return this; } public String getLastName() { return lastName; } public Passport setLastName(String value) { this.lastName = value; return this; } public String getDateOfBirth() { return dateOfBirth; } public Passport setDateOfBirth(String value) { this.dateOfBirth = value; return this; } public String getGender() { return gender; } public Passport setGender(String value) { this.gender = value; return this; } public String getMrzLineOne() { return mrzLineOne; } public Passport setMrzLineOne(String value) { this.mrzLineOne = value; return this; } public String getMrzLineTwo1() { return mrzLineTwo1; } public Passport setMrzLineTwo1(String value) { this.mrzLineTwo1 = value; return this; } public String getMrzLineTwo2() { return mrzLineTwo2; } public Passport setMrzLineTwo2(String value) { this.mrzLineTwo2 = value; return this; } public String getMrzLineTwo3() { return mrzLineTwo3; } public Passport setMrzLineTwo3(String value) { this.mrzLineTwo3 = value; return this; } public String getMrzLineTwo4() { return mrzLineTwo4; } public Passport setMrzLineTwo4(String value) { this.mrzLineTwo4 = value; return this; } public String getMrzLineTwo5() { return mrzLineTwo5; } public Passport setMrzLineTwo5(String value) { this.mrzLineTwo5 = value; return this; } public String getMrzLineTwo6() { return mrzLineTwo6; } public Passport setMrzLineTwo6(String value) { this.mrzLineTwo6 = value; return this; } public String getMrzLineTwo7() { return mrzLineTwo7; } public Passport setMrzLineTwo7(String value) { this.mrzLineTwo7 = value; return this; } public String getMrzLineTwo8() { return mrzLineTwo8; } public Passport setMrzLineTwo8(String value) { this.mrzLineTwo8 = value; return this; } public ArrayOfImages getImages() { return images; } public Passport setImages(ArrayOfImages value) { this.images = value; return this; } public Boolean getIsVerified() { return isVerified; } public Passport setIsVerified(Boolean value) { this.isVerified = value; return this; } public Boolean getIsFaceMatch() { return isFaceMatch; } public Passport setIsFaceMatch(Boolean value) { this.isFaceMatch = value; return this; } public BigDecimal getFaceMatchConfidence() { return faceMatchConfidence; } public Passport setFaceMatchConfidence(BigDecimal value) { this.faceMatchConfidence = value; return this; } public Boolean isHasPcvSearch() { return hasPcvSearch; } public Passport setHasPcvSearch(Boolean value) { this.hasPcvSearch = value; return this; } public Boolean isHasDfaSearch() { return hasDfaSearch; } public Passport setHasDfaSearch(Boolean value) { this.hasDfaSearch = value; return this; } public Boolean getIsPassportChipVerified() { return isPassportChipVerified; } public Passport setIsPassportChipVerified(Boolean value) { this.isPassportChipVerified = value; return this; } public PassportChipData getPassportChipData() { return passportChipData; } public Passport setPassportChipData(PassportChipData value) { this.passportChipData = value; return this; } public Boolean getIsEligibleForPcv() { return isEligibleForPcv; } public Passport setIsEligibleForPcv(Boolean value) { this.isEligibleForPcv = value; return this; } public Boolean getIsEligibleForDfa() { return isEligibleForDfa; } public Passport setIsEligibleForDfa(Boolean value) { this.isEligibleForDfa = value; return this; } } public static class DrivingLicence { public Integer clientFileId = null; public String firstName = null; public String middleName = null; public String lastName = null; public String dateOfBirth = null; public String address = null; public String drivingLicenceNumber = null; public ArrayOfImages images = null; public Boolean isVerified = null; public Boolean isFaceMatch = null; public BigDecimal faceMatchConfidence = null; public Boolean hasDfaSearch = null; public Integer getClientFileId() { return clientFileId; } public DrivingLicence setClientFileId(Integer value) { this.clientFileId = value; return this; } public String getFirstName() { return firstName; } public DrivingLicence setFirstName(String value) { this.firstName = value; return this; } public String getMiddleName() { return middleName; } public DrivingLicence setMiddleName(String value) { this.middleName = value; return this; } public String getLastName() { return lastName; } public DrivingLicence setLastName(String value) { this.lastName = value; return this; } public String getDateOfBirth() { return dateOfBirth; } public DrivingLicence setDateOfBirth(String value) { this.dateOfBirth = value; return this; } public String getAddress() { return address; } public DrivingLicence setAddress(String value) { this.address = value; return this; } public String getDrivingLicenceNumber() { return drivingLicenceNumber; } public DrivingLicence setDrivingLicenceNumber(String value) { this.drivingLicenceNumber = value; return this; } public ArrayOfImages getImages() { return images; } public DrivingLicence setImages(ArrayOfImages value) { this.images = value; return this; } public Boolean getIsVerified() { return isVerified; } public DrivingLicence setIsVerified(Boolean value) { this.isVerified = value; return this; } public Boolean getIsFaceMatch() { return isFaceMatch; } public DrivingLicence setIsFaceMatch(Boolean value) { this.isFaceMatch = value; return this; } public BigDecimal getFaceMatchConfidence() { return faceMatchConfidence; } public DrivingLicence setFaceMatchConfidence(BigDecimal value) { this.faceMatchConfidence = value; return this; } public Boolean isHasDfaSearch() { return hasDfaSearch; } public DrivingLicence setHasDfaSearch(Boolean value) { this.hasDfaSearch = value; return this; } } public static class OtherDocument { public Integer clientFileId = null; public String type = null; public String typeOther = null; public String description = null; public String originalImageUrl = null; public String croppedImageUrl = null; public Boolean isVerified = null; public Integer getClientFileId() { return clientFileId; } public OtherDocument setClientFileId(Integer value) { this.clientFileId = value; return this; } public String getType() { return type; } public OtherDocument setType(String value) { this.type = value; return this; } public String getTypeOther() { return typeOther; } public OtherDocument setTypeOther(String value) { this.typeOther = value; return this; } public String getDescription() { return description; } public OtherDocument setDescription(String value) { this.description = value; return this; } public String getOriginalImageUrl() { return originalImageUrl; } public OtherDocument setOriginalImageUrl(String value) { this.originalImageUrl = value; return this; } public String getCroppedImageUrl() { return croppedImageUrl; } public OtherDocument setCroppedImageUrl(String value) { this.croppedImageUrl = value; return this; } public Boolean getIsVerified() { return isVerified; } public OtherDocument setIsVerified(Boolean value) { this.isVerified = value; return this; } } public static class ArrayOfResponseError extends ArrayList { } public static class ArrayOfProofOfDocuments extends ArrayList { } public static class ArrayOfImages extends ArrayList { } public static class PassportChipData { public Boolean isIssuerVerified = null; public String issuerCommonName = null; public String issuerOrganisationName = null; public String issuerCountry = null; public String mrzLine1 = null; public String mrzLine2 = null; public Boolean isMrzLine1Verified = null; public Boolean isMrzLine2Verified = null; public ArrayList dataGroupsVerified = null; public ArrayList dataGroupsFailed = null; public Boolean isFaceMatch = null; public BigDecimal faceMatchConfidence = null; public Boolean getIsIssuerVerified() { return isIssuerVerified; } public PassportChipData setIsIssuerVerified(Boolean value) { this.isIssuerVerified = value; return this; } public String getIssuerCommonName() { return issuerCommonName; } public PassportChipData setIssuerCommonName(String value) { this.issuerCommonName = value; return this; } public String getIssuerOrganisationName() { return issuerOrganisationName; } public PassportChipData setIssuerOrganisationName(String value) { this.issuerOrganisationName = value; return this; } public String getIssuerCountry() { return issuerCountry; } public PassportChipData setIssuerCountry(String value) { this.issuerCountry = value; return this; } public String getMrzLine1() { return mrzLine1; } public PassportChipData setMrzLine1(String value) { this.mrzLine1 = value; return this; } public String getMrzLine2() { return mrzLine2; } public PassportChipData setMrzLine2(String value) { this.mrzLine2 = value; return this; } public Boolean getIsMrzLine1Verified() { return isMrzLine1Verified; } public PassportChipData setIsMrzLine1Verified(Boolean value) { this.isMrzLine1Verified = value; return this; } public Boolean getIsMrzLine2Verified() { return isMrzLine2Verified; } public PassportChipData setIsMrzLine2Verified(Boolean value) { this.isMrzLine2Verified = value; return this; } public ArrayList getDataGroupsVerified() { return dataGroupsVerified; } public PassportChipData setDataGroupsVerified(ArrayList value) { this.dataGroupsVerified = value; return this; } public ArrayList getDataGroupsFailed() { return dataGroupsFailed; } public PassportChipData setDataGroupsFailed(ArrayList value) { this.dataGroupsFailed = value; return this; } public Boolean getIsFaceMatch() { return isFaceMatch; } public PassportChipData setIsFaceMatch(Boolean value) { this.isFaceMatch = value; return this; } public BigDecimal getFaceMatchConfidence() { return faceMatchConfidence; } public PassportChipData setFaceMatchConfidence(BigDecimal value) { this.faceMatchConfidence = value; return this; } } public static class Image { public Integer id = null; public String name = null; public Integer ocrId = null; public String url = null; public Integer getId() { return id; } public Image setId(Integer value) { this.id = value; return this; } public String getName() { return name; } public Image setName(String value) { this.name = value; return this; } public Integer getOcrId() { return ocrId; } public Image setOcrId(Integer value) { this.ocrId = value; return this; } public String getUrl() { return url; } public Image setUrl(String value) { this.url = value; return this; } } public static class ProofOfDocument { /** * The ID of the ProofOfDocument */ @ApiMember(Description="The ID of the ProofOfDocument", IsRequired=true) public Integer id = null; /** * The name of the ProofOfDocument */ @ApiMember(Description="The name of the ProofOfDocument", IsRequired=true) public String name = null; public Integer getId() { return id; } public ProofOfDocument setId(Integer value) { this.id = value; return this; } public String getName() { return name; } public ProofOfDocument setName(String value) { this.name = value; return this; } } }