Skip to main content
PUT
/
perks
/
consumers
/
{consumer_id}
/
kyc
Create or update a consumer's KYC (Mangopay natural user).
curl --request PUT \
  --url https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/kyc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "birthday": "2023-12-25",
  "country_of_residence": "<string>",
  "nationality": "<string>"
}
'
import requests

url = "https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/kyc"

payload = {
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"birthday": "2023-12-25",
"country_of_residence": "<string>",
"nationality": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: '<string>',
first_name: '<string>',
last_name: '<string>',
birthday: '2023-12-25',
country_of_residence: '<string>',
nationality: '<string>'
})
};

fetch('https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/kyc', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/kyc",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'birthday' => '2023-12-25',
'country_of_residence' => '<string>',
'nationality' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/kyc"

payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"birthday\": \"2023-12-25\",\n \"country_of_residence\": \"<string>\",\n \"nationality\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/kyc")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"birthday\": \"2023-12-25\",\n \"country_of_residence\": \"<string>\",\n \"nationality\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-{programRef}.sandbox.paylead.tech/perks/consumers/{consumer_id}/kyc")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"birthday\": \"2023-12-25\",\n \"country_of_residence\": \"<string>\",\n \"nationality\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "birthday": "2023-12-25",
  "country_of_residence": "<string>",
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "nationality": "<string>",
  "natural_user_id": "<string>",
  "status": "<string>"
}
{
"code": "PL-400-06",
"status": 400,
"title": "KYC Rejected"
}
{
"code": "PL-401-00",
"status": 401,
"title": "Unauthorized"
}
{
"code": "PL-403-01",
"status": 403,
"title": "Consumer Pool Not Enabled"
}
{
"code": "PL-404-02",
"status": 404,
"title": "Consumer Not Enrolled"
}
{
"code": "PL-502-03",
"status": 502,
"title": "PSP Service Unavailable"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-version
string
default:2.0.0
Authorization
string | null

Path Parameters

consumer_id
string
required
Required string length: 2 - 100
Pattern: ^[a-zA-Z0-9_.-]*$

Body

application/json
email
string
required
first_name
string
required
Minimum string length: 1
last_name
string
required
Minimum string length: 1
birthday
string<date> | null
country_of_residence
string | null
nationality
string | null

Response

Successful Response

birthday
string<date> | null
required
country_of_residence
string | null
required
email
string
required
first_name
string
required
last_name
string
required
nationality
string | null
required
natural_user_id
string
required
status
string
required