Client
Represents a client.
The date when a client was set as active for the first time.
2016-09-06T13:37:50+03:00addresses object[]
The addresses associated with this client.
The city for the address.
The country.
The address encoded key, which is unique and generated.
The index of this address in the list of addresses.
The GPS latitude of this address in signed degrees format (DDD.dddd) with 6 decimal positions, ranging from -90 to +90.
The first line of the address.
The second line of the address.
The GPS longitude of this address in signed degrees format (DDD.dddd) with 6 decimal positions, ranging from -180 to +180.
The address parent key indicating the object owning this address. For example: client, centre, or branch.
The post code.
The region for the address.
The date when a client was approved.
2016-09-06T13:37:50+03:00The encoded key of the branch a client is assigned to.
The encoded key of the centre a client is assigned to.
The encoded key of the user a client is assigned to.
The client's date of birth.
1987-04-26A role which describes the intended use of a client in the system.
The date when the client state was changed to closed.
2016-09-06T13:37:50+03:00The date a client was created.
2016-09-06T13:37:50+03:00The client's email address.
The encoded key of the client, which is unique and generated.
The first name, personal name, given name, or forename of the client.
The client's gender, the options are male or female.
Possible values: [MALE, FEMALE]
The groups to which this client belongs.
Number of paid and closed (with 'obligations met') accounts for a client's group; when the closing operation is reverted, this is reduced.
The client's home phone number.
The ID of the client, which can be generated and customized - but must be unique.
idDocuments object[]
The identification documents for this client.
attachments object[]
A list containing information about the attached files for this document
The creation date of the document, stored as UTC
2016-09-06T13:37:50+03:00The document encodedKey
The original file name of the document
The file size of the document
The document id
The last modified date of the document, stored as UTC
2016-09-06T13:37:50+03:00Location where the document can be found, eg /myfiles/mypicture.jpeg
The name of the document
Detailed notes about the document
Represents the holder of this document. If null, means nobody is the owner of this document
Determines the owner type of the document
Possible values: [CLIENT, GROUP, LOAN_PRODUCT, SAVINGS_PRODUCT, CENTRE, BRANCH, USER, LOAN_ACCOUNT, DEPOSIT_ACCOUNT, ID_DOCUMENT, LINE_OF_CREDIT, GL_JOURNAL_ENTRY]
The extension of the document
The encoded key of the client that owns this document
The id of the document
The type of the document, Passport, Id card Drivers license, etc.
The encoded key of the document, generated, unique
Encoded key of the template used for this document
This document's index in the list of documents
Authority that issued the document, eg. Police
Date when the validity of the document ends
1987-04-26The last date a client was modified.
2016-09-06T13:37:50+03:00The last name, surname, or family name of the client.
Number of paid and closed (with 'obligations met') accounts for a client; when the closing operation is reverted, this is reduced.
The middle name of the client.
The migration event encoded key associated with a client.
The client's mobile phone number.
The client's second mobile phone number.
The additional notes about a client.
portalSettings object
Represents portal settings for an individual client.
The encoded key of the entity, generated, globally unique
The last date the client logged in to the portal.
2016-09-06T13:37:50+03:00The state of the client portal for a client
Possible values: [ENABLED, DISABLED]
The client's preferred language. This will determine the language for the reports, schedules, and account statements you generate for the client.
Possible values: [ENGLISH, PORTUGESE, SPANISH, RUSSIAN, FRENCH, GEORGIAN, CHINESE, INDONESIAN, ROMANIAN, BURMESE, GERMAN, PORTUGUESE_BRAZIL, VIETNAMESE, ITALIAN, THAI, NORWEGIAN, PHRASE]
The encoded key of a client's profile picture.
The encoded key of the client's profile signature.
The state of a client. It shows where the client is in the client life cycle.
Possible values: [PENDING_APPROVAL, INACTIVE, ACTIVE, EXITED, BLACKLISTED, REJECTED]
{
"activationDate": "2016-09-06T13:37:50+03:00",
"addresses": [
{
"city": "string",
"country": "string",
"encodedKey": "string",
"indexInList": 0,
"latitude": 0,
"line1": "string",
"line2": "string",
"longitude": 0,
"parentKey": "string",
"postcode": "string",
"region": "string"
}
],
"approvedDate": "2016-09-06T13:37:50+03:00",
"assignedBranchKey": "string",
"assignedCentreKey": "string",
"assignedUserKey": "string",
"birthDate": "1987-04-26",
"clientRoleKey": "string",
"closedDate": "2016-09-06T13:37:50+03:00",
"creationDate": "2016-09-06T13:37:50+03:00",
"emailAddress": "string",
"encodedKey": "string",
"firstName": "string",
"gender": "MALE",
"groupKeys": [
"string"
],
"groupLoanCycle": 0,
"homePhone": "string",
"id": "string",
"idDocuments": [
{
"attachments": [
{
"creationDate": "2016-09-06T13:37:50+03:00",
"encodedKey": "string",
"fileName": "string",
"fileSize": 0,
"id": 0,
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"location": "string",
"name": "string",
"notes": "string",
"ownerKey": "string",
"ownerType": "CLIENT",
"type": "string"
}
],
"clientKey": "string",
"documentId": "string",
"documentType": "string",
"encodedKey": "string",
"identificationDocumentTemplateKey": "string",
"indexInList": 0,
"issuingAuthority": "string",
"validUntil": "1987-04-26"
}
],
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"lastName": "string",
"loanCycle": 0,
"middleName": "string",
"migrationEventKey": "string",
"mobilePhone": "string",
"mobilePhone2": "string",
"notes": "string",
"portalSettings": {
"encodedKey": "string",
"lastLoggedInDate": "2016-09-06T13:37:50+03:00",
"portalState": "ENABLED"
},
"preferredLanguage": "ENGLISH",
"profilePictureKey": "string",
"profileSignatureKey": "string",
"state": "PENDING_APPROVAL"
}