Update a person

PATCH

applications

{applicationId}

persons

{personId}

Update a person

curl --request PATCH \
  --url https://api.example.com/v2/applications/{applicationId}/persons/{personId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bvn": "<string>",
  "dateOfBirth": "1985-06-15",
  "emailAddress": "jsmith@example.com",
  "firstName": "<string>",
  "lastName": "<string>",
  "middleName": "<string>",
  "nationalId": "<string>",
  "nationality": "<string>",
  "occupationCode": "111011",
  "ownershipPercentage": 50,
  "phoneNumber": "<string>",
  "taxId": "<string>",
  "title": "<string>"
}
'

import requests

url = "https://api.example.com/v2/applications/{applicationId}/persons/{personId}"

payload = {
    "bvn": "<string>",
    "dateOfBirth": "1985-06-15",
    "emailAddress": "jsmith@example.com",
    "firstName": "<string>",
    "lastName": "<string>",
    "middleName": "<string>",
    "nationalId": "<string>",
    "nationality": "<string>",
    "occupationCode": "111011",
    "ownershipPercentage": 50,
    "phoneNumber": "<string>",
    "taxId": "<string>",
    "title": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bvn: '<string>',
    dateOfBirth: '1985-06-15',
    emailAddress: 'jsmith@example.com',
    firstName: '<string>',
    lastName: '<string>',
    middleName: '<string>',
    nationalId: '<string>',
    nationality: '<string>',
    occupationCode: '111011',
    ownershipPercentage: 50,
    phoneNumber: '<string>',
    taxId: '<string>',
    title: '<string>'
  })
};

fetch('https://api.example.com/v2/applications/{applicationId}/persons/{personId}', 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.example.com/v2/applications/{applicationId}/persons/{personId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'bvn' => '<string>',
    'dateOfBirth' => '1985-06-15',
    'emailAddress' => 'jsmith@example.com',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'middleName' => '<string>',
    'nationalId' => '<string>',
    'nationality' => '<string>',
    'occupationCode' => '111011',
    'ownershipPercentage' => 50,
    'phoneNumber' => '<string>',
    'taxId' => '<string>',
    'title' => '<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.example.com/v2/applications/{applicationId}/persons/{personId}"

	payload := strings.NewReader("{\n  \"bvn\": \"<string>\",\n  \"dateOfBirth\": \"1985-06-15\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"nationalId\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"occupationCode\": \"111011\",\n  \"ownershipPercentage\": 50,\n  \"phoneNumber\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"title\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/v2/applications/{applicationId}/persons/{personId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bvn\": \"<string>\",\n  \"dateOfBirth\": \"1985-06-15\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"nationalId\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"occupationCode\": \"111011\",\n  \"ownershipPercentage\": 50,\n  \"phoneNumber\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/applications/{applicationId}/persons/{personId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bvn\": \"<string>\",\n  \"dateOfBirth\": \"1985-06-15\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"nationalId\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"occupationCode\": \"111011\",\n  \"ownershipPercentage\": 50,\n  \"phoneNumber\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"title\": \"<string>\"\n}"

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

{
  "dateOfBirth": "1985-06-15",
  "emailAddress": "jsmith@example.com",
  "firstName": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lastName": "<string>",
  "nationality": "<string>",
  "phoneNumber": "<string>",
  "residentialAddress": {
    "city": "<string>",
    "country": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "street": "<string>"
  },
  "role": "director",
  "title": "<string>",
  "bvn": "<string>",
  "gender": "male",
  "middleName": "<string>",
  "nationalId": "<string>",
  "occupationCode": "111011",
  "ownershipPercentage": 50,
  "taxId": "<string>"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}

Authorizations

Authorization

string

header

required

Enter Auth0 JWT token

Path Parameters

applicationId

string<uuid>

required

personId

string<uuid>

required

Body

application/json

bvn

string

Bank Verification Number (Nigeria).

dateOfBirth

string<date>

Example:

"1985-06-15"

emailAddress

string<email>

firstName

string

gender

enum<string>

Gender. Required by the KYC of some payment providers; supply it when this person is the beneficial owner of a business collecting USD.

Available options:

male,

female,

other

lastName

string

middleName

string

nationalId

string

nationality

string

ISO 3166-1 alpha-2 country code

occupationCode

string

US Standard Occupational Classification code, 6 digits with any dashes removed (e.g. "111011"). Required for USD collection when this person is the beneficial owner.

Example:

"111011"

ownershipPercentage

number

Required range: 0 <= x <= 100

phoneNumber

string

residentialAddress

object

Show child attributes

role

enum<string>

Available options:

director,

shareholder,

director_and_shareholder,

signing_officer

taxId

string

Tax identifier, e.g. Kenya KRA PIN.

title

string

Response

dateOfBirth

string<date>

required

Example:

"1985-06-15"

emailAddress

string<email>

required

firstName

string

required

string<uuid>

required

lastName

string

required

nationality

string

required

ISO 3166-1 alpha-2 country code

phoneNumber

string

required

residentialAddress

object

required

Show child attributes

role

enum<string>

required

Available options:

director,

shareholder,

director_and_shareholder,

signing_officer

title

string

required

bvn

string

Bank Verification Number (Nigeria).

gender

enum<string>

Gender. Required by the KYC of some payment providers; supply it when this person is the beneficial owner of a business collecting USD.

Available options:

male,

female,

other

middleName

string

nationalId

string

occupationCode

string

US Standard Occupational Classification code, 6 digits with any dashes removed (e.g. "111011"). Required for USD collection when this person is the beneficial owner.

Example:

"111011"

ownershipPercentage

number

Required range: 0 <= x <= 100

taxId

string

Tax identifier, e.g. Kenya KRA PIN.

Update a person

curl --request PATCH \
  --url https://api.example.com/v2/applications/{applicationId}/persons/{personId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bvn": "<string>",
  "dateOfBirth": "1985-06-15",
  "emailAddress": "jsmith@example.com",
  "firstName": "<string>",
  "lastName": "<string>",
  "middleName": "<string>",
  "nationalId": "<string>",
  "nationality": "<string>",
  "occupationCode": "111011",
  "ownershipPercentage": 50,
  "phoneNumber": "<string>",
  "taxId": "<string>",
  "title": "<string>"
}
'

import requests

url = "https://api.example.com/v2/applications/{applicationId}/persons/{personId}"

payload = {
    "bvn": "<string>",
    "dateOfBirth": "1985-06-15",
    "emailAddress": "jsmith@example.com",
    "firstName": "<string>",
    "lastName": "<string>",
    "middleName": "<string>",
    "nationalId": "<string>",
    "nationality": "<string>",
    "occupationCode": "111011",
    "ownershipPercentage": 50,
    "phoneNumber": "<string>",
    "taxId": "<string>",
    "title": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bvn: '<string>',
    dateOfBirth: '1985-06-15',
    emailAddress: 'jsmith@example.com',
    firstName: '<string>',
    lastName: '<string>',
    middleName: '<string>',
    nationalId: '<string>',
    nationality: '<string>',
    occupationCode: '111011',
    ownershipPercentage: 50,
    phoneNumber: '<string>',
    taxId: '<string>',
    title: '<string>'
  })
};

fetch('https://api.example.com/v2/applications/{applicationId}/persons/{personId}', 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.example.com/v2/applications/{applicationId}/persons/{personId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'bvn' => '<string>',
    'dateOfBirth' => '1985-06-15',
    'emailAddress' => 'jsmith@example.com',
    'firstName' => '<string>',
    'lastName' => '<string>',
    'middleName' => '<string>',
    'nationalId' => '<string>',
    'nationality' => '<string>',
    'occupationCode' => '111011',
    'ownershipPercentage' => 50,
    'phoneNumber' => '<string>',
    'taxId' => '<string>',
    'title' => '<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.example.com/v2/applications/{applicationId}/persons/{personId}"

	payload := strings.NewReader("{\n  \"bvn\": \"<string>\",\n  \"dateOfBirth\": \"1985-06-15\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"nationalId\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"occupationCode\": \"111011\",\n  \"ownershipPercentage\": 50,\n  \"phoneNumber\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"title\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/v2/applications/{applicationId}/persons/{personId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bvn\": \"<string>\",\n  \"dateOfBirth\": \"1985-06-15\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"nationalId\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"occupationCode\": \"111011\",\n  \"ownershipPercentage\": 50,\n  \"phoneNumber\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/applications/{applicationId}/persons/{personId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bvn\": \"<string>\",\n  \"dateOfBirth\": \"1985-06-15\",\n  \"emailAddress\": \"jsmith@example.com\",\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"nationalId\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"occupationCode\": \"111011\",\n  \"ownershipPercentage\": 50,\n  \"phoneNumber\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"title\": \"<string>\"\n}"

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

{
  "dateOfBirth": "1985-06-15",
  "emailAddress": "jsmith@example.com",
  "firstName": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lastName": "<string>",
  "nationality": "<string>",
  "phoneNumber": "<string>",
  "residentialAddress": {
    "city": "<string>",
    "country": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "street": "<string>"
  },
  "role": "director",
  "title": "<string>",
  "bvn": "<string>",
  "gender": "male",
  "middleName": "<string>",
  "nationalId": "<string>",
  "occupationCode": "111011",
  "ownershipPercentage": 50,
  "taxId": "<string>"
}

{
  "error": "BAD_REQUEST",
  "message": "Bad Request",
  "path": "/v1/resource",
  "statusCode": 400,
  "timestamp": "2024-01-15T10:30:00.000Z"
}