Createorupdateclientrequest

addresses object[]

Description for addresses in CreateOrUpdateClientRequest

Array [

addressTypestring

Description for addressType in AddressApiV1

citystring

Description for city in AddressApiV1

countrystring

Description for country in AddressApiV1

encodedKeystring

Description for encodedKey in AddressApiV1

indexInListnumber

Description for indexInList in AddressApiV1

latitudenumber

Description for latitude in AddressApiV1

line1string

Description for line1 in AddressApiV1

line2string

Description for line2 in AddressApiV1

longitudenumber

Description for longitude in AddressApiV1

parentKeystring

Description for parentKey in AddressApiV1

postcodestring

Description for postcode in AddressApiV1

regionstring

Description for region in AddressApiV1

toBeDeletedboolean

Description for toBeDeleted in AddressApiV1

]

client object

Description for client in CreateOrUpdateClientRequest

activationDatestring

Description for activationDate in ClientApiV1

approvedDatestring

Description for approvedDate in ClientApiV1

assignedBranchKeystring

Description for assignedBranchKey in ClientApiV1

assignedCentreKeystring

Description for assignedCentreKey in ClientApiV1

assignedUserKeystring

Description for assignedUserKey in ClientApiV1

birthDatestring

Description for birthDate in ClientApiV1

clientRole object

Description for clientRole in ClientApiV1

encodedKeystring

Description for encodedKey in ClientRoleBasicApiV1

closedDatestring

Description for closedDate in ClientApiV1

creationDatestring

Description for creationDate in ClientApiV1

emailAddressstring

Description for emailAddress in ClientApiV1

encodedKeystring

Description for encodedKey in ClientApiV1

firstNamestring

Description for firstName in ClientApiV1

genderstring

Description for gender in ClientApiV1

Possible values: [MALE, FEMALE]

groupLoanCyclenumber

Description for groupLoanCycle in ClientApiV1

homePhonestring

Description for homePhone in ClientApiV1

idstring

Description for id in ClientApiV1

idPatternstring

Description for idPattern in ClientApiV1

lastModifiedDatestring

Description for lastModifiedDate in ClientApiV1

lastNamestring

Description for lastName in ClientApiV1

loanCyclenumber

Description for loanCycle in ClientApiV1

middleNamestring

Description for middleName in ClientApiV1

migrationEvent object

Description for migrationEvent in ClientApiV1

creationDatestring

Description for creationDate in DataMigrationEventApiV1

encodedKeystring

Description for encodedKey in DataMigrationEventApiV1

numCentresImportednumber

Description for numCentresImported in DataMigrationEventApiV1

numClientsImportednumber

Description for numClientsImported in DataMigrationEventApiV1

numGLAccountsImportednumber

Description for numGLAccountsImported in DataMigrationEventApiV1

numGroupsImportednumber

Description for numGroupsImported in DataMigrationEventApiV1

numLoanRepaymentsImportednumber

Description for numLoanRepaymentsImported in DataMigrationEventApiV1

numLoanTransactionsImportednumber

Description for numLoanTransactionsImported in DataMigrationEventApiV1

numLoansImportednumber

Description for numLoansImported in DataMigrationEventApiV1

numSavingsImportednumber

Description for numSavingsImported in DataMigrationEventApiV1

statestring

Description for state in DataMigrationEventApiV1

Possible values: [REVERTED, DRAFT, APPROVED]

typestring

Description for type in DataMigrationEventApiV1

Possible values: [IMPORT, EXPORT]

mobilePhone1string

Description for mobilePhone1 in ClientApiV1

mobilePhone2string

Description for mobilePhone2 in ClientApiV1

notesstring

Description for notes in ClientApiV1

portalPreferences object

Description for portalPreferences in ClientApiV1

encodedKeystring

Description for encodedKey in PortalPreferencesApiV1

lastLoggedInDatestring

Description for lastLoggedInDate in PortalPreferencesApiV1

passwordstring

Description for password in PortalPreferencesApiV1

portalStatestring

Description for portalState in PortalPreferencesApiV1

Possible values: [DISABLED, ENABLED]

preferredLanguagestring

Description for preferredLanguage in ClientApiV1

Possible values: [PORTUGESE, RUSSIAN, ROMANIAN, ENGLISH, SPANISH, GEORGIAN, BURMESE, PHRASE, CHINESE, FRENCH, INDONESIAN]

profilePictureKeystring

Description for profilePictureKey in ClientApiV1

profileSignatureKeystring

Description for profileSignatureKey in ClientApiV1

statestring

Description for state in ClientApiV1

Possible values: [PENDING_APPROVAL, ACTIVE, INACTIVE, EXITED, BLACKLISTED, REJECTED]

customInformation object[]

Description for customInformation in CreateOrUpdateClientRequest

Array [

customFieldIDstring

Description for customFieldID in CustomFieldValueRequest

customFieldSetGroupIndexnumber

Description for customFieldSetGroupIndex in CustomFieldValueRequest

linkedEntityKeyValuestring

Description for linkedEntityKeyValue in CustomFieldValueRequest

valuestring

Description for value in CustomFieldValueRequest

]

groupKeysstring[]

Description for groupKeys in CreateOrUpdateClientRequest

idDocuments object[]

Description for idDocuments in CreateOrUpdateClientRequest

Array [

clientKeystring

Description for clientKey in IdentificationDocumentApiV1

documentIdstring

Description for documentId in IdentificationDocumentApiV1

documentTypestring

Description for documentType in IdentificationDocumentApiV1

encodedKeystring

Description for encodedKey in IdentificationDocumentApiV1

identificationDocumentTemplateKeystring

Description for identificationDocumentTemplateKey in IdentificationDocumentApiV1

indexInListnumber

Description for indexInList in IdentificationDocumentApiV1

issuingAuthoritystring

Description for issuingAuthority in IdentificationDocumentApiV1

toBeDeletedboolean

Description for toBeDeleted in IdentificationDocumentApiV1

validUntilstring

Description for validUntil in IdentificationDocumentApiV1

validUntilDTOdate object

Description for validUntilDTOdate in IdentificationDocumentApiV1

dayOfMonthnumber

Description for dayOfMonth in DateDTOApiV1

monthOfYearnumber

Description for monthOfYear in DateDTOApiV1

yearnumber

Description for year in DateDTOApiV1

]

Createorupdateclientrequest

{
  "addresses": [
    {
      "addressType": "string",
      "city": "string",
      "country": "string",
      "encodedKey": "string",
      "indexInList": 0,
      "latitude": 0,
      "line1": "string",
      "line2": "string",
      "longitude": 0,
      "parentKey": "string",
      "postcode": "string",
      "region": "string",
      "toBeDeleted": true
    }
  ],
  "client": {
    "activationDate": "string",
    "approvedDate": "string",
    "assignedBranchKey": "string",
    "assignedCentreKey": "string",
    "assignedUserKey": "string",
    "birthDate": "string",
    "clientRole": {
      "encodedKey": "string"
    },
    "closedDate": "string",
    "creationDate": "string",
    "emailAddress": "string",
    "encodedKey": "string",
    "firstName": "string",
    "gender": "MALE",
    "groupLoanCycle": 0,
    "homePhone": "string",
    "id": "string",
    "idPattern": "string",
    "lastModifiedDate": "string",
    "lastName": "string",
    "loanCycle": 0,
    "middleName": "string",
    "migrationEvent": {
      "creationDate": "string",
      "encodedKey": "string",
      "numCentresImported": 0,
      "numClientsImported": 0,
      "numGLAccountsImported": 0,
      "numGroupsImported": 0,
      "numLoanRepaymentsImported": 0,
      "numLoanTransactionsImported": 0,
      "numLoansImported": 0,
      "numSavingsImported": 0,
      "state": "REVERTED",
      "type": "IMPORT"
    },
    "mobilePhone1": "string",
    "mobilePhone2": "string",
    "notes": "string",
    "portalPreferences": {
      "encodedKey": "string",
      "lastLoggedInDate": "string",
      "password": "string",
      "portalState": "DISABLED"
    },
    "preferredLanguage": "PORTUGESE",
    "profilePictureKey": "string",
    "profileSignatureKey": "string",
    "state": "PENDING_APPROVAL"
  },
  "customInformation": [
    {
      "customFieldID": "string",
      "customFieldSetGroupIndex": 0,
      "linkedEntityKeyValue": "string",
      "value": "string"
    }
  ],
  "groupKeys": [
    "string"
  ],
  "idDocuments": [
    {
      "clientKey": "string",
      "documentId": "string",
      "documentType": "string",
      "encodedKey": "string",
      "identificationDocumentTemplateKey": "string",
      "indexInList": 0,
      "issuingAuthority": "string",
      "toBeDeleted": true,
      "validUntil": "string",
      "validUntilDTOdate": {
        "dayOfMonth": 0,
        "monthOfYear": 0,
        "year": 0
      }
    }
  ]
}