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, but most of these will be recovered within the KYC Application :
| id required | string <uuid> |
| externalId | string |
required | object (PhoneInfoResponseDto) |
required | object (KycInfoResponseDto) |
| status required | string Enum: "ACTIVE" "LOCK" |
| termsAccepted required | boolean |
object (AddressResponseDto) Address used on the bank statements of your users. | |
| firstName | string |
| middleName | string |
| lastName | string |
required | object (EmailInfoResponseDto) |
| gender | string Enum: "MALE" "FEMALE" |
| birthIsoCountryCode | string (Iso3 Country Code) Enum: "ABW" "AFG" "AGO" "AIA" "ALA" "ALB" "AND" "ARE" "ARG" "ARM" "ASM" "ATA" "ATF" "ATG" "AUS" "AUT" "AZE" "BDI" "BEL" "BEN" "BES" "BFA" "BGD" "BGR" "BHR" "BHS" "BIH" "BLM" "BLR" "BLZ" "BMU" "BOL" "BRA" "BRB" "BRN" "BTN" "BVT" "BWA" "CAF" "CAN" "CCK" "CHE" "CHL" "CHN" "CIV" "CMR" "COD" "COG" "COK" "COL" "COM" "CPV" "CRI" "CUB" "CUW" "CXR" "CYM" "CYP" "CZE" "DEU" "DJI" "DMA" "DNK" "DOM" "DZA" "ECU" "EGY" "ERI" "ESH" "ESP" "EST" "ETH" "FIN" "FJI" "FLK" "FRA" "FRO" "FSM" "GAB" "GBR" "GEO" "GGY" "GHA" "GIB" "GIN" "GLP" "GMB" "GNB" "GNQ" "GRC" "GRD" "GRL" "GTM" "GUF" "GUM" "GUY" "HKG" "HMD" "HND" "HRV" "HTI" "HUN" "IDN" "IMN" "IND" "IOT" "IRL" "IRN" "IRQ" "ISL" "ISR" "ITA" "JAM" "JEY" "JOR" "JPN" "KAZ" "KEN" "KGZ" "KHM" "KIR" "KNA" "KOR" "KWT" "LAO" "LBN" "LBR" "LBY" "LCA" "LIE" "LKA" "LSO" "LTU" "LUX" "LVA" "MAC" "MAF" "MAR" "MCO" "MDA" "MDG" "MDV" "MEX" "MHL" "MKD" "MLI" "MLT" "MMR" "MNE" "MNG" "MNP" "MOZ" "MRT" "MSR" "MTQ" "MUS" "MWI" "MYS" "MYT" "NAM" "NCL" "NER" "NFK" "NGA" "NIC" "NIU" "NLD" "NOR" "NPL" "NRU" "NZL" "OMN" "PAK" "PAN" "PCN" "PER" "PHL" "PLW" "PNG" "POL" "PRI" "PRK" "PRT" "PRY" "PSE" "PYF" "QAT" "REU" "ROU" "RUS" "RWA" "SAU" "SDN" "SEN" "SGP" "SGS" "SHN" "SJM" "SLB" "SLE" "SLV" "SMR" "SOM" "SPM" "SRB" "SSD" "STP" "SUR" "SVK" "SVN" "SWE" "SWZ" "SXM" "SYC" "SYR" "TCA" "TCD" "TGO" "THA" "TJK" "TKL" "TKM" "TLS" "TON" "TTO" "TUN" "TUR" "TUV" "TWN" "TZA" "UGA" "UKR" "UMI" "URY" "USA" "UZB" "VAT" "VCT" "VEN" "VGB" "VIR" "VNM" "VUT" "WLF" "WSM" "YEM" "ZAF" "ZMB" "ZWE" |
| birthDate | string <date> |
| sourceOfFunds | string Enum: "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 |
| occupation | string Enum: "BUSINESS_OWNER" "CLERGY" "CRAFTSMAN" "ENGINEER" "EXECUTIVE" "FARMER" "FREELANCE" "LIBERAL_PROFESSION" "POLITICIAN" "PROFESSOR" "PUBLIC_SERVANT" "RETIRED" "SHOPKEEPER" "STUDENT" "UNEMPLOYED" "WORKER" "OTHER" |
| otherOccupation | string |
| notes | string Public additional information concerning this entity. |
| creationDate required | string <date-time> |
| updateDate required | string <date-time> |
object (ScaDeviceInfo) | |
| partnerMetadata | object (Metadata) |
| userMetadata | object (Metadata) |
Consumer Status
Consumer overall status is a combination of different status :
- KYC status : related to KYC procedure and
kycApplication. - Compliance status : related to risk scoring and screening, performed by Linkcy on a regular basis.
- Suspension status : indicates if the consumer is Suspended or not. This can be set with the "suspend / unsuspend a consumer" endpoints, or by automatic rules.
- Banking status : indicates if all the mandatory consumer data are present and validated, allowing him to use banking services.
- Linkcy status : Additional status related to Linkcy consistency checks
ACTIVE and the consumer can use LinkCy services.