Partial Update Person By ID

Partial update a person by id

curl --request PATCH \
  --url https://api-sandbox.orum.io/deliver/persons/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '
{
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "<string>",
  "social_security_number": "<string>",
  "addresses": [
    {
      "type": "home",
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US",
      "zip5": "<string>"
    }
  ],
  "contacts": [
    {
      "value": "<string>"
    }
  ],
  "metadata": {}
}
'

import requests

url = "https://api-sandbox.orum.io/deliver/persons/{id}"

payload = {
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "<string>",
    "social_security_number": "<string>",
    "addresses": [
        {
            "type": "home",
            "address1": "<string>",
            "address2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "country": "US",
            "zip5": "<string>"
        }
    ],
    "contacts": [{ "value": "<string>" }],
    "metadata": {}
}
headers = {
    "Orum-Version": "<orum-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Orum-Version': '<orum-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    first_name: '<string>',
    middle_name: '<string>',
    last_name: '<string>',
    date_of_birth: '<string>',
    social_security_number: '<string>',
    addresses: [
      {
        type: 'home',
        address1: '<string>',
        address2: '<string>',
        city: '<string>',
        state: '<string>',
        country: 'US',
        zip5: '<string>'
      }
    ],
    contacts: [{value: '<string>'}],
    metadata: {}
  })
};

fetch('https://api-sandbox.orum.io/deliver/persons/{id}', 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-sandbox.orum.io/deliver/persons/{id}",
  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([
    'first_name' => '<string>',
    'middle_name' => '<string>',
    'last_name' => '<string>',
    'date_of_birth' => '<string>',
    'social_security_number' => '<string>',
    'addresses' => [
        [
                'type' => 'home',
                'address1' => '<string>',
                'address2' => '<string>',
                'city' => '<string>',
                'state' => '<string>',
                'country' => 'US',
                'zip5' => '<string>'
        ]
    ],
    'contacts' => [
        [
                'value' => '<string>'
        ]
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Orum-Version: <orum-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-sandbox.orum.io/deliver/persons/{id}"

	payload := strings.NewReader("{\n  \"first_name\": \"<string>\",\n  \"middle_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"<string>\",\n  \"social_security_number\": \"<string>\",\n  \"addresses\": [\n    {\n      \"type\": \"home\",\n      \"address1\": \"<string>\",\n      \"address2\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country\": \"US\",\n      \"zip5\": \"<string>\"\n    }\n  ],\n  \"contacts\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metadata\": {}\n}")

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

	req.Header.Add("Orum-Version", "<orum-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.patch("https://api-sandbox.orum.io/deliver/persons/{id}")
  .header("Orum-Version", "<orum-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"<string>\",\n  \"middle_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"<string>\",\n  \"social_security_number\": \"<string>\",\n  \"addresses\": [\n    {\n      \"type\": \"home\",\n      \"address1\": \"<string>\",\n      \"address2\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country\": \"US\",\n      \"zip5\": \"<string>\"\n    }\n  ],\n  \"contacts\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.orum.io/deliver/persons/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Orum-Version"] = '<orum-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"first_name\": \"<string>\",\n  \"middle_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"<string>\",\n  \"social_security_number\": \"<string>\",\n  \"addresses\": [\n    {\n      \"type\": \"home\",\n      \"address1\": \"<string>\",\n      \"address2\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country\": \"US\",\n      \"zip5\": \"<string>\"\n    }\n  ],\n  \"contacts\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metadata\": {}\n}"

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

{
  "person": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_reference_id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "middle_name": "<string>",
    "date_of_birth": "<string>",
    "addresses": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "address1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US",
        "zip5": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "address2": "<string>"
      }
    ],
    "contacts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "value": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "status_reasons": [
      {
        "reason_code": "invalid_address",
        "reason_code_message": "Address submitted is a non-supported address type"
      }
    ],
    "closed_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

{
  "error_code": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "error_code": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "error_code": "<string>",
  "message": "<string>",
  "details": {}
}

PATCH

deliver

persons

{id}

Partial update a person by id

curl --request PATCH \
  --url https://api-sandbox.orum.io/deliver/persons/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '
{
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "<string>",
  "social_security_number": "<string>",
  "addresses": [
    {
      "type": "home",
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "US",
      "zip5": "<string>"
    }
  ],
  "contacts": [
    {
      "value": "<string>"
    }
  ],
  "metadata": {}
}
'

import requests

url = "https://api-sandbox.orum.io/deliver/persons/{id}"

payload = {
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "<string>",
    "social_security_number": "<string>",
    "addresses": [
        {
            "type": "home",
            "address1": "<string>",
            "address2": "<string>",
            "city": "<string>",
            "state": "<string>",
            "country": "US",
            "zip5": "<string>"
        }
    ],
    "contacts": [{ "value": "<string>" }],
    "metadata": {}
}
headers = {
    "Orum-Version": "<orum-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Orum-Version': '<orum-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    first_name: '<string>',
    middle_name: '<string>',
    last_name: '<string>',
    date_of_birth: '<string>',
    social_security_number: '<string>',
    addresses: [
      {
        type: 'home',
        address1: '<string>',
        address2: '<string>',
        city: '<string>',
        state: '<string>',
        country: 'US',
        zip5: '<string>'
      }
    ],
    contacts: [{value: '<string>'}],
    metadata: {}
  })
};

fetch('https://api-sandbox.orum.io/deliver/persons/{id}', 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-sandbox.orum.io/deliver/persons/{id}",
  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([
    'first_name' => '<string>',
    'middle_name' => '<string>',
    'last_name' => '<string>',
    'date_of_birth' => '<string>',
    'social_security_number' => '<string>',
    'addresses' => [
        [
                'type' => 'home',
                'address1' => '<string>',
                'address2' => '<string>',
                'city' => '<string>',
                'state' => '<string>',
                'country' => 'US',
                'zip5' => '<string>'
        ]
    ],
    'contacts' => [
        [
                'value' => '<string>'
        ]
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Orum-Version: <orum-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-sandbox.orum.io/deliver/persons/{id}"

	payload := strings.NewReader("{\n  \"first_name\": \"<string>\",\n  \"middle_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"<string>\",\n  \"social_security_number\": \"<string>\",\n  \"addresses\": [\n    {\n      \"type\": \"home\",\n      \"address1\": \"<string>\",\n      \"address2\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country\": \"US\",\n      \"zip5\": \"<string>\"\n    }\n  ],\n  \"contacts\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metadata\": {}\n}")

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

	req.Header.Add("Orum-Version", "<orum-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.patch("https://api-sandbox.orum.io/deliver/persons/{id}")
  .header("Orum-Version", "<orum-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"<string>\",\n  \"middle_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"<string>\",\n  \"social_security_number\": \"<string>\",\n  \"addresses\": [\n    {\n      \"type\": \"home\",\n      \"address1\": \"<string>\",\n      \"address2\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country\": \"US\",\n      \"zip5\": \"<string>\"\n    }\n  ],\n  \"contacts\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.orum.io/deliver/persons/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Orum-Version"] = '<orum-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"first_name\": \"<string>\",\n  \"middle_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"<string>\",\n  \"social_security_number\": \"<string>\",\n  \"addresses\": [\n    {\n      \"type\": \"home\",\n      \"address1\": \"<string>\",\n      \"address2\": \"<string>\",\n      \"city\": \"<string>\",\n      \"state\": \"<string>\",\n      \"country\": \"US\",\n      \"zip5\": \"<string>\"\n    }\n  ],\n  \"contacts\": [\n    {\n      \"value\": \"<string>\"\n    }\n  ],\n  \"metadata\": {}\n}"

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

{
  "person": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customer_reference_id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "middle_name": "<string>",
    "date_of_birth": "<string>",
    "addresses": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "address1": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "US",
        "zip5": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "address2": "<string>"
      }
    ],
    "contacts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "value": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "status_reasons": [
      {
        "reason_code": "invalid_address",
        "reason_code_message": "Address submitted is a non-supported address type"
      }
    ],
    "closed_at": "2023-11-07T05:31:56Z",
    "metadata": {}
  }
}

{
  "error_code": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "error_code": "<string>",
  "message": "<string>",
  "details": {}
}

{
  "error_code": "<string>",
  "message": "<string>",
  "details": {}
}

Authorizations

Authorization

string

header

required

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

Headers

Orum-Version

enum<string>

required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:

v2022-09-21

Path Parameters

string<uuid>

required

Orum generated unique id for the resource for the person resource you are updating. Orum generated unique id for the resource.

Body

application/json

first_name

string | null

Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Required string length: 1 - 255

Pattern:

^[ ’!"#$%&'()*+,-./:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿĀāĂăĄąĆćĈĉĊċČčĎďĐđĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıĲĳĴĵĶķĸĹĺĻļĽľĿŀŁłŃńŅņŇňŉŊŋŌōŎŏŐőŒœŔŕŖŗŘřŚśŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵŶŷŸŹźŻżŽžſ]+$

middle_name

string | null

Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Maximum string length: 255

Pattern:

^[ ’!"#$%&'()*+,-./:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿĀāĂăĄąĆćĈĉĊċČčĎďĐđĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıĲĳĴĵĶķĸĹĺĻļĽľĿŀŁłŃńŅņŇňŉŊŋŌōŎŏŐőŒœŔŕŖŗŘřŚśŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵŶŷŸŹźŻżŽžſ]*$

last_name

string | null

Accepts latin characters and hyphens, dashes, periods, apostrophes, spaces, and diacritics.

Required string length: 1 - 255

Pattern:

^[ ’!"#$%&'()*+,-./:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿĀāĂăĄąĆćĈĉĊċČčĎďĐđĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħĨĩĪīĬĭĮįİıĲĳĴĵĶķĸĹĺĻļĽľĿŀŁłŃńŅņŇňŉŊŋŌōŎŏŐőŒœŔŕŖŗŘřŚśŜŝŞşŠšŢţŤťŦŧŨũŪūŬŭŮůŰűŲųŴŵŶŷŸŹźŻżŽžſ]+$

date_of_birth

string | null

Date of birth in YYYY-MM-DD format. Note: This field is required for payouts, deposits, or account-to-account transfers. Age must be less than 100 years and greater than 18 years to be verified.

Pattern: ^((19|20)\d\d)-(0[1-9]|1[0-2])-(([01])[0-9]|2[0-9]|3[0-1])$

Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN) in XXX-XX-XXXX format. An example dummy value is 123-45-6789. Note: This field is required for payouts, deposits, or account-to-account transfers.

addresses

PersonPatchPostalAddressRequest · object[] | null

Address information for the person. "type" is required if you are updating other address fields. Note: This field is required for payouts, deposits, or account-to-account transfers.

Maximum array length: 1

Show child attributes

contacts

ContactBasePerson · object[] | null

Optional list of contact information for the person. If object is present, either phone and/or email contact types are accepted. A maximum of three persons or businesses can have the same phone number.

Maximum array length: 2

Show child attributes

metadata

object | null

Additional data you would like to provide on the resource. The field supports valid JSON of up to 5 key-value pairs with a maximum of 20 characters for the key and 50 characters for the value. Do not include any sensitive information.

Response

200 response.

person

object

required

Show child attributes

Update Person By Customer Reference ID Close Person By ID

Auth API

Deliver API

Verify API

Webhooks API

Partial Update Person By ID

Authorizations

Headers

Path Parameters

Body

Response