HIFI Docs

Update an associated party

curl --request PATCH \
  --url https://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "roles": [
    "<string>"
  ],
  "businessTitle": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "nationality": "<string>",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "dateOfBirth": "2023-12-25",
  "gender": "<string>",
  "taxId": "<string>",
  "taxIdType": "<string>",
  "taxIdCountry": "<string>",
  "relationshipEstablishedAt": "2023-12-25",
  "shareProportion": 50
}
'

import requests

url = "https://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}"

payload = {
    "roles": ["<string>"],
    "businessTitle": "<string>",
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "nationality": "<string>",
    "email": "jsmith@example.com",
    "phoneNumber": "<string>",
    "dateOfBirth": "2023-12-25",
    "gender": "<string>",
    "taxId": "<string>",
    "taxIdType": "<string>",
    "taxIdCountry": "<string>",
    "relationshipEstablishedAt": "2023-12-25",
    "shareProportion": 50
}
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({
    roles: ['<string>'],
    businessTitle: '<string>',
    firstName: '<string>',
    middleName: '<string>',
    lastName: '<string>',
    nationality: '<string>',
    email: 'jsmith@example.com',
    phoneNumber: '<string>',
    dateOfBirth: '2023-12-25',
    gender: '<string>',
    taxId: '<string>',
    taxIdType: '<string>',
    taxIdCountry: '<string>',
    relationshipEstablishedAt: '2023-12-25',
    shareProportion: 50
  })
};

fetch('https://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}', 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://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}",
  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([
    'roles' => [
        '<string>'
    ],
    'businessTitle' => '<string>',
    'firstName' => '<string>',
    'middleName' => '<string>',
    'lastName' => '<string>',
    'nationality' => '<string>',
    'email' => 'jsmith@example.com',
    'phoneNumber' => '<string>',
    'dateOfBirth' => '2023-12-25',
    'gender' => '<string>',
    'taxId' => '<string>',
    'taxIdType' => '<string>',
    'taxIdCountry' => '<string>',
    'relationshipEstablishedAt' => '2023-12-25',
    'shareProportion' => 50
  ]),
  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://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}"

	payload := strings.NewReader("{\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"businessTitle\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"taxIdType\": \"<string>\",\n  \"taxIdCountry\": \"<string>\",\n  \"relationshipEstablishedAt\": \"2023-12-25\",\n  \"shareProportion\": 50\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://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"businessTitle\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"taxIdType\": \"<string>\",\n  \"taxIdCountry\": \"<string>\",\n  \"relationshipEstablishedAt\": \"2023-12-25\",\n  \"shareProportion\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}")

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  \"roles\": [\n    \"<string>\"\n  ],\n  \"businessTitle\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"taxIdType\": \"<string>\",\n  \"taxIdCountry\": \"<string>\",\n  \"relationshipEstablishedAt\": \"2023-12-25\",\n  \"shareProportion\": 50\n}"

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

{
  "roles": [
    "<string>"
  ],
  "businessTitle": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "nationality": "<string>",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "physicalAddress": {
    "addressLine1": "<string>",
    "city": "<string>",
    "stateProvinceRegion": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "addressLine2": "<string>"
  },
  "dateOfBirth": "2023-12-25",
  "gender": "<string>",
  "taxId": "<string>",
  "taxIdType": "<string>",
  "taxIdCountry": "<string>",
  "relationshipEstablishedAt": "2023-12-25",
  "shareProportion": 50
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_NOT_FOUND",
  "message": "<string>",
  "fields": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

PATCH

users

{userId}

compliance

associated-parties

{associatedPartyId}

Update an associated party

curl --request PATCH \
  --url https://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "roles": [
    "<string>"
  ],
  "businessTitle": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "nationality": "<string>",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "dateOfBirth": "2023-12-25",
  "gender": "<string>",
  "taxId": "<string>",
  "taxIdType": "<string>",
  "taxIdCountry": "<string>",
  "relationshipEstablishedAt": "2023-12-25",
  "shareProportion": 50
}
'

import requests

url = "https://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}"

payload = {
    "roles": ["<string>"],
    "businessTitle": "<string>",
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "nationality": "<string>",
    "email": "jsmith@example.com",
    "phoneNumber": "<string>",
    "dateOfBirth": "2023-12-25",
    "gender": "<string>",
    "taxId": "<string>",
    "taxIdType": "<string>",
    "taxIdCountry": "<string>",
    "relationshipEstablishedAt": "2023-12-25",
    "shareProportion": 50
}
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({
    roles: ['<string>'],
    businessTitle: '<string>',
    firstName: '<string>',
    middleName: '<string>',
    lastName: '<string>',
    nationality: '<string>',
    email: 'jsmith@example.com',
    phoneNumber: '<string>',
    dateOfBirth: '2023-12-25',
    gender: '<string>',
    taxId: '<string>',
    taxIdType: '<string>',
    taxIdCountry: '<string>',
    relationshipEstablishedAt: '2023-12-25',
    shareProportion: 50
  })
};

fetch('https://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}', 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://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}",
  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([
    'roles' => [
        '<string>'
    ],
    'businessTitle' => '<string>',
    'firstName' => '<string>',
    'middleName' => '<string>',
    'lastName' => '<string>',
    'nationality' => '<string>',
    'email' => 'jsmith@example.com',
    'phoneNumber' => '<string>',
    'dateOfBirth' => '2023-12-25',
    'gender' => '<string>',
    'taxId' => '<string>',
    'taxIdType' => '<string>',
    'taxIdCountry' => '<string>',
    'relationshipEstablishedAt' => '2023-12-25',
    'shareProportion' => 50
  ]),
  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://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}"

	payload := strings.NewReader("{\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"businessTitle\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"taxIdType\": \"<string>\",\n  \"taxIdCountry\": \"<string>\",\n  \"relationshipEstablishedAt\": \"2023-12-25\",\n  \"shareProportion\": 50\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://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"businessTitle\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"taxIdType\": \"<string>\",\n  \"taxIdCountry\": \"<string>\",\n  \"relationshipEstablishedAt\": \"2023-12-25\",\n  \"shareProportion\": 50\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://production.hifi.com/v3/users/{userId}/compliance/associated-parties/{associatedPartyId}")

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  \"roles\": [\n    \"<string>\"\n  ],\n  \"businessTitle\": \"<string>\",\n  \"firstName\": \"<string>\",\n  \"middleName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"nationality\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"phoneNumber\": \"<string>\",\n  \"dateOfBirth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"taxId\": \"<string>\",\n  \"taxIdType\": \"<string>\",\n  \"taxIdCountry\": \"<string>\",\n  \"relationshipEstablishedAt\": \"2023-12-25\",\n  \"shareProportion\": 50\n}"

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

{
  "roles": [
    "<string>"
  ],
  "businessTitle": "<string>",
  "firstName": "<string>",
  "middleName": "<string>",
  "lastName": "<string>",
  "nationality": "<string>",
  "email": "jsmith@example.com",
  "phoneNumber": "<string>",
  "physicalAddress": {
    "addressLine1": "<string>",
    "city": "<string>",
    "stateProvinceRegion": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "addressLine2": "<string>"
  },
  "dateOfBirth": "2023-12-25",
  "gender": "<string>",
  "taxId": "<string>",
  "taxIdType": "<string>",
  "taxIdCountry": "<string>",
  "relationshipEstablishedAt": "2023-12-25",
  "shareProportion": 50
}

{
  "type": "VALIDATION_ERROR",
  "message": "One or more fields are invalid or missing.",
  "fields": [
    {
      "code": "invalid_value",
      "message": "Must be a valid email address",
      "field": "email"
    }
  ]
}

{
  "type": "UNAUTHORIZED",
  "message": "Authentication required"
}

{
  "type": "RESOURCE_NOT_FOUND",
  "message": "<string>",
  "fields": [
    {
      "code": "<string>",
      "message": "<string>",
      "field": "<string>"
    }
  ]
}

{
  "type": "INTERNAL_SERVER_ERROR",
  "message": "An internal server error occurred"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId

string

required

ID of the user.

Pattern: ^user_[A-Za-z0-9]+$

associatedPartyId

string

required

Public ID of the associated party (prefixed with ap_)

Body

application/json

roles

string[]

Minimum array length: 1

businessTitle

string

Pattern: ^[\x20-\x7E\n]*$

firstName

string

Pattern: ^[\x20-\x7E\n]*$

middleName

string

Pattern: ^[\x20-\x7E\n]*$

lastName

string

Pattern: ^[\x20-\x7E\n]*$

nationality

string

Required string length: 3

string<email>

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

phoneNumber

string

Required string length: 6 - 15

Pattern: ^\d+$

physicalAddress

object

Show child attributes

dateOfBirth

string<date>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

gender

string

taxId

string

taxIdType

string

taxIdCountry

string

Required string length: 3

relationshipEstablishedAt

string<date>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Required range: 0 <= x <= 100

Response

An associated party.

roles

string[]

required

Minimum array length: 1

businessTitle

string

Pattern: ^[\x20-\x7E\n]*$

firstName

string

Pattern: ^[\x20-\x7E\n]*$

middleName

string

Pattern: ^[\x20-\x7E\n]*$

lastName

string

Pattern: ^[\x20-\x7E\n]*$

nationality

string

Required string length: 3

string<email>

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

phoneNumber

string

Required string length: 6 - 15

Pattern: ^\d+$

physicalAddress

object

Show child attributes

dateOfBirth

string<date>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

gender

string

taxId

string

taxIdType

string

taxIdCountry

string

Required string length: 3

relationshipEstablishedAt

string<date>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Required range: 0 <= x <= 100

⌘I

Overview

Endpoints

Update an associated party

Authorizations

Path Parameters

Body

Response