Consumer

The consumer represents the individual partner client. It must have a valid phone number and be formally identified with a KYC procedure before carrying out any operation.

List your consumers

Fetch all your consumer end-users. More options will be added in the near future.

SecurityLinkcy-Auth
Request
query Parameters
sortAttribute
string
Enum: "UPDATE_DATE" "LAST_NAME"
phone
string
pageSize
integer <int32> [ 0 .. 100 ]
Default: 20

The size of the page to be returned.

page
integer <int32> >= 0
Default: 0

The page number.

sortDirection
string
Enum: "ASC" "DESC"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

get/api/partner/consumers
Request samples
Response samples
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}

Create a consumer

This is the first step to create an Individual consumer. Phone object is mandatory to be able to go on to the next steps. You can add optional fields, this will help us to manage compliance triggers.

Only a few pieces of information are asked here, most of it will be extracted from documents during the KYC process. By doing the Endpoint: Get Consumer information, you will get access to all data.

You cannot create two consumers with the same phone number. Phone numbers must be unique.

SecurityLinkcy-Auth or
Request
Request Body schema: application/json
partnerName
string

The partnerName, mandatory if you create a consumer as anonymous. Ignored if requesting as a partner.

externalId
string [ 0 .. 511 ] characters

A unique identifier that you can use to link this consumer to a user in your system.

required
object (PhoneRequestDto)
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 [ 0 .. 511 ] characters

Description of source of funds if 'OTHER' was chosen.

occupation
string

The consumer usual or principal work or business as a means of earning a living.

Enum: "BUSINESS_OWNER" "CLERGY" "CRAFTSMAN" "ENGINEER" "EXECUTIVE" "FARMER" "FREELANCE" "LIBERAL_PROFESSION" "POLITICIAN" "PROFESSOR" "PUBLIC_SERVANT" "RETIRED" "SHOPKEEPER" "STUDENT" "UNEMPLOYED" "WORKER" "OTHER"
otherOccupation
string [ 0 .. 511 ] characters

Description of occupation if 'OTHER' was chosen.

lastTermsAccepted
string

The version of the terms and conditions signed by the consumer.

object (Metadata)

A custom field to save data.

This field's size is limited to 3000 characters.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409
500

Internal Server Error

post/api/partner/consumers
Request samples
application/json
{
  • "partnerName": "string",
  • "externalId": "string",
  • "phone": {
    },
  • "sourceOfFunds": "COMPENSATION_PAYOUT",
  • "otherSourceOfFunds": "string",
  • "occupation": "BUSINESS_OWNER",
  • "otherOccupation": "string",
  • "lastTermsAccepted": "1.0",
  • "metadata": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Get consumer's information

Get all information about one consumer by only using his consumer ID. You will get access to all verification statuses.

SecurityLinkcy-Auth
Request
path Parameters
consumerId
required
string <uuid>
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

get/api/partner/consumers/{consumerId}
Request samples
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "externalId": "string",
  • "phone": {
    },
  • "kycInfo": {
    },
  • "termsAccepted": true,
  • "address": {
    },
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "email": {
    },
  • "gender": "MALE",
  • "birthIsoCountryCode": "string",
  • "birthDate": "2019-08-24",
  • "sourceOfFunds": "COMPENSATION_PAYOUT",
  • "otherSourceOfFunds": "string",
  • "occupation": "BUSINESS_OWNER",
  • "otherOccupation": "string",
  • "notes": "string",
  • "creationDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "strongAuthentication": {
    },
  • "partnerMetadata": { },
  • "userMetadata": { }
}

Update a consumer

You can patch a consumer to update some information. Depending on the information patched, you will have to perform another action:

  • External ID -> no action to perform

  • Phone -> you will need to use Endpoint POST Send consumer verification code & validate consumer phone

  • Address : we will use our tools to check if the address is valid or not, we recommend you to ask your consumer to confirm the address once the modification is done. Address is very important to send cards. Once the card is activated, the address status will go from valid to verified.

  • Email address -> The "emailAddressVerified" status will switch to "false" you will need to use Endpoint POST Send a verification email to the consumer to verify the email address.

  • Source of funds -> no action to perform

  • Occupation -> no action to perform

  • Terms & Condition -> Needed if "termsAccepted" is "false".

SecurityLinkcy-Auth
Request
path Parameters
consumerId
required
string <uuid>
Request Body schema: application/json
externalId
string [ 0 .. 511 ] characters

A unique identifier that you can use to link this consumer to a user in your system.

object (AddressRequestDto)
emailAddress
string
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 [ 0 .. 511 ] characters

Description of source of funds if 'OTHER' was chosen.

occupation
string

The consumer usual or principal work or business as a means of earning a living.

Enum: "BUSINESS_OWNER" "CLERGY" "CRAFTSMAN" "ENGINEER" "EXECUTIVE" "FARMER" "FREELANCE" "LIBERAL_PROFESSION" "POLITICIAN" "PROFESSOR" "PUBLIC_SERVANT" "RETIRED" "SHOPKEEPER" "STUDENT" "UNEMPLOYED" "WORKER" "OTHER"
otherOccupation
string [ 0 .. 511 ] characters

Description of occupation if 'OTHER' was chosen.

lastTermsAccepted
string

The version of the terms and conditions signed by the end-user.

object (Metadata)

A custom field to save data.

This field's size is limited to 3000 characters.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

patch/api/partner/consumers/{consumerId}
Request samples
application/json
{
  • "externalId": "string",
  • "address": {
    },
  • "emailAddress": "string",
  • "sourceOfFunds": "COMPENSATION_PAYOUT",
  • "otherSourceOfFunds": "string",
  • "occupation": "BUSINESS_OWNER",
  • "otherOccupation": "string",
  • "lastTermsAccepted": "1.0",
  • "metadata": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "updateDate": "2019-08-24T14:15:22Z"
}