Consumer overview
A consumer is identified by a unique Id (UUID).
It is also identified by its phone number which must be unique : in case of direct connection to the API by the Consumer, its username will be its phone number.
A consumer has a lot of details. Most of these will be recovered within the KYC Application :
| Name | Type | Description |
|---|---|---|
| id | string (UUID) | Unique identifier of the consumer. |
| externalId | string | External identifier of the consumer. |
| phone | object (PhoneInfoResponseDto) | Consumer's phone information. |
| kycInfo | object (KycInfoResponseDto) | Consumer's KYC information. |
| status | string | Consumer status. Possible values: ACTIVE, LOCK. |
| termsAccepted | boolean | Indicates whether the terms and conditions have been accepted. |
| address | object (AddressResponseDto) | Address used on the consumer's bank statements. |
| firstName | string | Consumer's first name. |
| middleName | string | Consumer's middle name. |
| lastName | string | Consumer's last name. |
| object (EmailInfoResponseDto) | Consumer's email information. | |
| gender | string | Consumer's gender. Possible values: MALE, FEMALE. |
| birthIsoCountryCode | string (ISO3 country code) | ISO code of the consumer's country of birth. |
| birthDate | string (date) | Consumer's birth date. |
| sourceOfFunds | string | Source of funds. Possible values: COMPENSATION_PAYOUT, COMPANY_PROFITS, COMPANY_SALE, DIVIDEND_PAYMENTS, DIVORCE_SETTLEMENT, FIXED_DEPOSITS, GIFT, INHERITANCE, INSURANCE_PAYOUT, LOAN, LOTTERY_OR_GAMBLING_WIN, RETIREMENT_INCOME, SALE_OF_INVESTMENT, SALE_OF_PROPERTY, SAVINGS_FROM_SALARY, OTHER. |
| otherSourceOfFunds | string | Other source of funds if OTHER is selected. |
| occupation | string | Consumer's occupation. Possible values: BUSINESS_OWNER, CLERGY, CRAFTSMAN, ENGINEER, EXECUTIVE, FARMER, FREELANCE, LIBERAL_PROFESSION, POLITICIAN, PROFESSOR, PUBLIC_SERVANT, RETIRED, SHOPKEEPER, STUDENT, UNEMPLOYED, WORKER, OTHER. |
| otherOccupation | string | Other occupation if OTHER is selected. |
| notes | string | Public additional information about this entity. |
| creationDate | string (date-time) | Consumer's creation date. |
| updateDate | string (date-time) | Consumer's last update date. |
| strongAuthentication | object (ScaDeviceInfo) | Strong authentication information. |
| partnerMetadata | object (Metadata) | Partner's metadata. |
| userMetadata | object (Metadata) | User's metadata. |
Consumer Status
Consumer overall status is a combination of different status :
| Status | Description |
|---|---|
| KYC | Related to KYC procedure and kycApplication |
| Compliance | Related to risk scoring and screening, performed by Linkcy on a regular basis |
| Suspension | Indicates if the consumer is Suspended or not. This can be set with the "suspend / unsuspend a consumer" endpoints, or by automatic rules |
| Banking | Indicates if all the mandatory consumer data are present and validated, allowing him to use banking services. |
| Linkcy | Additional status related to Linkcy consistency checks |
When all these status have a VALIDATED/ACTIVE/UNSUSPEND value, then the overall status is ACTIVE and the consumer can use LinkCy services.