Update associated person proof-of-address
curl --request PATCH \
--url https://api.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "document-submission",
"input": {
"media": [
{
"context": "address-proof",
"fileId": "459c0447-8916-4bad-bb67-f2354fcfb10b"
}
]
}
}
'import requests
url = "https://api.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address"
payload = {
"type": "document-submission",
"input": { "media": [
{
"context": "address-proof",
"fileId": "459c0447-8916-4bad-bb67-f2354fcfb10b"
}
] }
}
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({
type: 'document-submission',
input: {
media: [{context: 'address-proof', fileId: '459c0447-8916-4bad-bb67-f2354fcfb10b'}]
}
})
};
fetch('https://api.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address', 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.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address",
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([
'type' => 'document-submission',
'input' => [
'media' => [
[
'context' => 'address-proof',
'fileId' => '459c0447-8916-4bad-bb67-f2354fcfb10b'
]
]
]
]),
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.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address"
payload := strings.NewReader("{\n \"type\": \"document-submission\",\n \"input\": {\n \"media\": [\n {\n \"context\": \"address-proof\",\n \"fileId\": \"459c0447-8916-4bad-bb67-f2354fcfb10b\"\n }\n ]\n }\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.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"document-submission\",\n \"input\": {\n \"media\": [\n {\n \"context\": \"address-proof\",\n \"fileId\": \"459c0447-8916-4bad-bb67-f2354fcfb10b\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address")
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 \"type\": \"document-submission\",\n \"input\": {\n \"media\": [\n {\n \"context\": \"address-proof\",\n \"fileId\": \"459c0447-8916-4bad-bb67-f2354fcfb10b\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"proofOfAddress": {
"code": "proof-of-address",
"status": "running",
"type": "document-submission",
"input": {
"media": [
{
"context": "address-proof",
"fileId": "459c0447-8916-4bad-bb67-f2354fcfb10b"
}
]
}
}
}Associated persons
Update associated person proof-of-address
Update the proof-of-address process for an associated person.
PATCH
/
core
/
kyb
/
associated-persons
/
{personId}
/
processes
/
proof-of-address
Update associated person proof-of-address
curl --request PATCH \
--url https://api.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "document-submission",
"input": {
"media": [
{
"context": "address-proof",
"fileId": "459c0447-8916-4bad-bb67-f2354fcfb10b"
}
]
}
}
'import requests
url = "https://api.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address"
payload = {
"type": "document-submission",
"input": { "media": [
{
"context": "address-proof",
"fileId": "459c0447-8916-4bad-bb67-f2354fcfb10b"
}
] }
}
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({
type: 'document-submission',
input: {
media: [{context: 'address-proof', fileId: '459c0447-8916-4bad-bb67-f2354fcfb10b'}]
}
})
};
fetch('https://api.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address', 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.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address",
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([
'type' => 'document-submission',
'input' => [
'media' => [
[
'context' => 'address-proof',
'fileId' => '459c0447-8916-4bad-bb67-f2354fcfb10b'
]
]
]
]),
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.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address"
payload := strings.NewReader("{\n \"type\": \"document-submission\",\n \"input\": {\n \"media\": [\n {\n \"context\": \"address-proof\",\n \"fileId\": \"459c0447-8916-4bad-bb67-f2354fcfb10b\"\n }\n ]\n }\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.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"document-submission\",\n \"input\": {\n \"media\": [\n {\n \"context\": \"address-proof\",\n \"fileId\": \"459c0447-8916-4bad-bb67-f2354fcfb10b\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.enterprise.sandbox.uphold.com/core/kyb/associated-persons/{personId}/processes/proof-of-address")
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 \"type\": \"document-submission\",\n \"input\": {\n \"media\": [\n {\n \"context\": \"address-proof\",\n \"fileId\": \"459c0447-8916-4bad-bb67-f2354fcfb10b\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"proofOfAddress": {
"code": "proof-of-address",
"status": "running",
"type": "document-submission",
"input": {
"media": [
{
"context": "address-proof",
"fileId": "459c0447-8916-4bad-bb67-f2354fcfb10b"
}
]
}
}
}This endpoint is not yet available in Sandbox or Production.
Authorizations
OAuth 2.0 authentication.
Path Parameters
The unique identifier of the associated person.
Body
application/json
Response
Associated person proof-of-address updated successfully.
The proof-of-address process for an associated person.
- None
- Document submission
Show child attributes
Show child attributes
Was this page helpful?
⌘I