Now that we have covered how you onboard a business and issue cards and account for it, let's check what is needed to create consumer.
Creating a user
You can create user for consumers, depending on the business case you have configured with us. This user can be assigned under a business you onboarded, or it can be assigned directly to your company.
The same API request is used in both situations. The only difference in the data in the request is how the “merchant” field is used.
Specification of the API and example request can be found at the following URL - Paynetics create user API documentation
If you fill in the “merchant” field with the unique token ID provided during the creation of the business, you will be assigning the user under the merchant corresponding to the token ID.
If you leave the field empty, the user will be directly tied to your company in the Paynetics`s platform.
Depending on the setup done during your onboarding we will define the mandatory attributes to create a user.
AML check request
Before you send the request to create consumer, you need to call the AML endpoint and perform the needed anti money laundry check:
The request contains only basic data for the consumer: Two names, nationality, and date of birth.
Request example:
{
"first_name": "Jane",
"last_name": "Doe",
"nationality": "UK",
"birthday": "1983-12-01"
}AML check response:
{
"code": 0,
"data": {
"token": "0ba5e81d-c43b-4008-b2d6-0d390f6f8c08"
}
}The response will generate a unique token ID, for this check, which then needs to be added in the create_user request, which we will now do, to create the needed user.
The user_create request contains the data necessary for the creation such as: names, address and contact info, occupation and education, ID documents and other type of documents for KYC purposes.
Example request:
{
"email": "Jane.Doe@example.com",
"first_name": "Joane",
"last_name": "Doe",
"address1": "8th Tonsley PI",
"address2": "string",
"country": "UK",
"city": "London",
"zip": "SW181BP",
"phone": "+440000000",
"mobile_phone": "+440000000",
"language": "string",
"nationality": “GB",
"birthday": "GB",
"aml": "0ba5e81d-c43b-4008-b2d6-0d390f6f8c08", // here we place the unique token ID from the AML check we did previously
"place_of_birth": "London",
"merchant": "", // in this case the consumer we create can be company employ to whom we might want to payout monthly bonus and him/her usie it via a card.
"occupation": "engineer",
"education": "masters degree",
"info": "string", // Field is not checked is info field for the user which can be used for different use cases
"money_declaration": "string",
"source_of_funds": "string",
"external_reference": "empl2345", // This field is used to put reference ID through which this person can be linked to employe system you use
"registration_ip": "string",
"is_san": "string",
"peps_declaration": "string",
"pep": "string",
"pep_relative": "string",
"unique_identifier": "string",
"id_passport_validity": "string",
"id_passport_number": "string",
"type": "string",
"documents": [
{
"file": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3/HwADvgI9/iYBsgAAAABJRU5ErkJggg==",
"file_type": "pdf",
"document_type": "passport"
}
]
}Response example:
{
"email": " Jane.Doe@example.com ",
"first_name": "Jane",
"last_name": "Doe",
"address1": "J 8th Tonsley P ",
"address2": "string",
"country": "UK",
"city": "London",
"zip": " SW181BP ",
"phone": "+440000000",
"mobile_phone": "+440000000",
"language": "string",
"nationality": "GB",
"birthday": "GB",
"aml": "0ba5e81d-c43b-4008-b2d6-0d390f6f8c08",
"place_of_birth": "London",
"merchant": "",
"occupation": "engineer",
"education": "masters degree",
"info": "string",
"money_declaration": "string",
"source_of_funds": "string",
"external_reference": "string",
"registration_ip": "string",
"is_san": "string",
"peps_declaration": "string",
"pep": "string",
"pep_relative": "string",
"unique_identifier": "string",
"id_passport_validity": "string",
"id_passport_number": "string",
"type": "string",
"documents": [
{
"file": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNksP3/HwADvgI9/iYBsgAAAABJRU5ErkJggg==",
"file_type": "pdf",
"document_type": "passport"
}
]
}Once a request, which has the proper data and passes the needed validations is sent via the API, a response will be returned. The response will contain unique user token ID
After the user is created you can use accordingly:
user_update to update the information of the user. In the request you need to provide the unique user token ID and place information only in the fields which need to be updated. Fields are same as in the user_create request.
user_details to list the information which was provided in the request for the user creation. The request requires the user token ID to be provided so it can pull the correct data and show it.
user_remove is used for deleting an already created user from the system
Specification of the API and example of the user_update,user_details and user_remove requests can be found at the following URL - Paynetics update,list,remove user API documentation