Create or update a consumer's KYC (Mangopay natural user).

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' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "address": {
    "address_line_1": "12 rue de la Paix",
    "city": "Paris",
    "country": "FR",
    "postal_code": "75002",
    "address_line_2": "Bâtiment B",
    "region": "Île-de-France"
  },
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "birthday": "1990-05-15",
  "country_of_residence": "FR",
  "nationality": "FR"
}
'

import requests

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

payload = {
    "address": {
        "address_line_1": "12 rue de la Paix",
        "city": "Paris",
        "country": "FR",
        "postal_code": "75002",
        "address_line_2": "Bâtiment B",
        "region": "Île-de-France"
    },
    "email": "jane.doe@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "birthday": "1990-05-15",
    "country_of_residence": "FR",
    "nationality": "FR"
}
headers = {
    "x-api-version": "<x-api-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-api-version': '<x-api-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    address: {
      address_line_1: '12 rue de la Paix',
      city: 'Paris',
      country: 'FR',
      postal_code: '75002',
      address_line_2: 'Bâtiment B',
      region: 'Île-de-France'
    },
    email: 'jane.doe@example.com',
    first_name: 'Jane',
    last_name: 'Doe',
    birthday: '1990-05-15',
    country_of_residence: 'FR',
    nationality: 'FR'
  })
};

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([
    'address' => [
        'address_line_1' => '12 rue de la Paix',
        'city' => 'Paris',
        'country' => 'FR',
        'postal_code' => '75002',
        'address_line_2' => 'Bâtiment B',
        'region' => 'Île-de-France'
    ],
    'email' => 'jane.doe@example.com',
    'first_name' => 'Jane',
    'last_name' => 'Doe',
    'birthday' => '1990-05-15',
    'country_of_residence' => 'FR',
    'nationality' => 'FR'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-api-version: <x-api-version>"
  ],
]);

$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  \"address\": {\n    \"address_line_1\": \"12 rue de la Paix\",\n    \"city\": \"Paris\",\n    \"country\": \"FR\",\n    \"postal_code\": \"75002\",\n    \"address_line_2\": \"Bâtiment B\",\n    \"region\": \"Île-de-France\"\n  },\n  \"email\": \"jane.doe@example.com\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"birthday\": \"1990-05-15\",\n  \"country_of_residence\": \"FR\",\n  \"nationality\": \"FR\"\n}")

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

	req.Header.Add("x-api-version", "<x-api-version>")
	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("x-api-version", "<x-api-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": {\n    \"address_line_1\": \"12 rue de la Paix\",\n    \"city\": \"Paris\",\n    \"country\": \"FR\",\n    \"postal_code\": \"75002\",\n    \"address_line_2\": \"Bâtiment B\",\n    \"region\": \"Île-de-France\"\n  },\n  \"email\": \"jane.doe@example.com\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"birthday\": \"1990-05-15\",\n  \"country_of_residence\": \"FR\",\n  \"nationality\": \"FR\"\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["x-api-version"] = '<x-api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": {\n    \"address_line_1\": \"12 rue de la Paix\",\n    \"city\": \"Paris\",\n    \"country\": \"FR\",\n    \"postal_code\": \"75002\",\n    \"address_line_2\": \"Bâtiment B\",\n    \"region\": \"Île-de-France\"\n  },\n  \"email\": \"jane.doe@example.com\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"birthday\": \"1990-05-15\",\n  \"country_of_residence\": \"FR\",\n  \"nationality\": \"FR\"\n}"

response = http.request(request)
puts response.read_body

{
  "address": {
    "address_line_1": "12 rue de la Paix",
    "city": "Paris",
    "country": "FR",
    "postal_code": "75002",
    "address_line_2": "Bâtiment B",
    "region": "Île-de-France"
  },
  "birthday": "1990-05-15",
  "country_of_residence": "FR",
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "nationality": "FR",
  "natural_user_id": "mp-nat-000123",
  "status": "VALIDATED"
}

{
  "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

required

Path Parameters

consumer_id

string

required

Required string length: 2 - 100

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"consumer-12345"

Body

application/json

address

AddressToUpsertSchema · object

required

Residential address of the consumer. Required by the PSP to create the consumer's payout recipient.

Show child attributes

string

required

Example:

"jane.doe@example.com"

first_name

string

required

Minimum string length: 1

Example:

"Jane"

last_name

string

required

Minimum string length: 1

Example:

"Doe"

birthday

string<date> | null

Example:

"1990-05-15"

country_of_residence

string | null

Example:

"FR"

nationality

string | null

Example:

"FR"

Response

Successful Response

address

AddressSchema · object

required

Residential address of the consumer stored on the PSP.

Show child attributes

birthday

string<date> | null

required

Example:

"1990-05-15"

country_of_residence

string | null

required

Example:

"FR"

string

required

Example:

"jane.doe@example.com"

first_name

string

required

Example:

"Jane"

last_name

string

required

Example:

"Doe"

nationality

string | null

required

Example:

"FR"

natural_user_id

string

required

Example:

"mp-nat-000123"

status

string

required

Example:

"VALIDATED"

⌘I

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' \
  --header 'x-api-version: <x-api-version>' \
  --data '
{
  "address": {
    "address_line_1": "12 rue de la Paix",
    "city": "Paris",
    "country": "FR",
    "postal_code": "75002",
    "address_line_2": "Bâtiment B",
    "region": "Île-de-France"
  },
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "birthday": "1990-05-15",
  "country_of_residence": "FR",
  "nationality": "FR"
}
'

import requests

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

payload = {
    "address": {
        "address_line_1": "12 rue de la Paix",
        "city": "Paris",
        "country": "FR",
        "postal_code": "75002",
        "address_line_2": "Bâtiment B",
        "region": "Île-de-France"
    },
    "email": "jane.doe@example.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "birthday": "1990-05-15",
    "country_of_residence": "FR",
    "nationality": "FR"
}
headers = {
    "x-api-version": "<x-api-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {
    'x-api-version': '<x-api-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    address: {
      address_line_1: '12 rue de la Paix',
      city: 'Paris',
      country: 'FR',
      postal_code: '75002',
      address_line_2: 'Bâtiment B',
      region: 'Île-de-France'
    },
    email: 'jane.doe@example.com',
    first_name: 'Jane',
    last_name: 'Doe',
    birthday: '1990-05-15',
    country_of_residence: 'FR',
    nationality: 'FR'
  })
};

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([
    'address' => [
        'address_line_1' => '12 rue de la Paix',
        'city' => 'Paris',
        'country' => 'FR',
        'postal_code' => '75002',
        'address_line_2' => 'Bâtiment B',
        'region' => 'Île-de-France'
    ],
    'email' => 'jane.doe@example.com',
    'first_name' => 'Jane',
    'last_name' => 'Doe',
    'birthday' => '1990-05-15',
    'country_of_residence' => 'FR',
    'nationality' => 'FR'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-api-version: <x-api-version>"
  ],
]);

$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  \"address\": {\n    \"address_line_1\": \"12 rue de la Paix\",\n    \"city\": \"Paris\",\n    \"country\": \"FR\",\n    \"postal_code\": \"75002\",\n    \"address_line_2\": \"Bâtiment B\",\n    \"region\": \"Île-de-France\"\n  },\n  \"email\": \"jane.doe@example.com\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"birthday\": \"1990-05-15\",\n  \"country_of_residence\": \"FR\",\n  \"nationality\": \"FR\"\n}")

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

	req.Header.Add("x-api-version", "<x-api-version>")
	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("x-api-version", "<x-api-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": {\n    \"address_line_1\": \"12 rue de la Paix\",\n    \"city\": \"Paris\",\n    \"country\": \"FR\",\n    \"postal_code\": \"75002\",\n    \"address_line_2\": \"Bâtiment B\",\n    \"region\": \"Île-de-France\"\n  },\n  \"email\": \"jane.doe@example.com\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"birthday\": \"1990-05-15\",\n  \"country_of_residence\": \"FR\",\n  \"nationality\": \"FR\"\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["x-api-version"] = '<x-api-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": {\n    \"address_line_1\": \"12 rue de la Paix\",\n    \"city\": \"Paris\",\n    \"country\": \"FR\",\n    \"postal_code\": \"75002\",\n    \"address_line_2\": \"Bâtiment B\",\n    \"region\": \"Île-de-France\"\n  },\n  \"email\": \"jane.doe@example.com\",\n  \"first_name\": \"Jane\",\n  \"last_name\": \"Doe\",\n  \"birthday\": \"1990-05-15\",\n  \"country_of_residence\": \"FR\",\n  \"nationality\": \"FR\"\n}"

response = http.request(request)
puts response.read_body

{
  "address": {
    "address_line_1": "12 rue de la Paix",
    "city": "Paris",
    "country": "FR",
    "postal_code": "75002",
    "address_line_2": "Bâtiment B",
    "region": "Île-de-France"
  },
  "birthday": "1990-05-15",
  "country_of_residence": "FR",
  "email": "jane.doe@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "nationality": "FR",
  "natural_user_id": "mp-nat-000123",
  "status": "VALIDATED"
}

{
  "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"
}

Authentication

Consumers

Perks

Resources

Create or update a consumer's KYC (Mangopay natural user).

Authorizations

Headers

Path Parameters

Body

Response