> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create associated person
> Create a new associated person for a business user.
export const RestEndpointSubjects = ({subjects = []}) => {
const subjectToIconMap = {
'client': 'browser',
'user:individual': 'user',
'user:business': 'briefcase'
};
if (subjects.length === 0) {
return null;
}
return <>
{subjects.map(subject =>
{subject}
)}
;
};
This endpoint is currently available in **Sandbox** only. It is not yet available in **Production**.
**Create associated person** registers an individual tied to the business, such as a beneficial owner or an authorized signer, and returns the `id` you use to complete their processes.
## Types
`type` is the only required field, and it determines what the person represents:
* `beneficial-owner`: An individual who ultimately owns or controls a share of the business. Accepts `ownershipPercentage`.
* `authorized-signer`: An individual authorized to act on behalf of the business. Does not accept `ownershipPercentage`.
* `beneficial-owner-and-authorized-signer`: An individual who is both. Accepts `ownershipPercentage`.
The type cannot be changed after creation. To correct it, [delete](./delete-associated-person) the person and create them again.
## Progressive creation
Every field other than `type` is optional at creation, so you can register a person as soon as you know their role and fill in the rest later through [Update associated person profile](./update-profile).
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json post /core/kyb/associated-persons
openapi: 3.1.0
info:
version: 0.1.0
title: Core API
description: >-
The Core API provides essential building blocks that empower businesses to
embed financial services into their applications.
contact:
name: Uphold API Team
email: developers@uphold.com
url: https://developer.uphold.com
servers:
- url: https://api.enterprise.sandbox.uphold.com
description: Sandbox
- url: https://api.enterprise.uphold.com
description: Production
security:
- OAuth2: []
tags:
- name: Authentication
description: Authentication.
- name: Countries
description: Countries.
- name: Users
description: Users.
- name: KYC
description: Individual User's KYC.
- name: KYB
description: Business User's KYB.
- name: Capabilities
description: User capabilities.
- name: Terms of service
description: User terms of service.
- name: Files
description: Files.
- name: Assets
description: Assets, networks and rails.
- name: Accounts
description: Accounts.
- name: External accounts
description: External accounts.
- name: Transactions
description: Transactions.
- name: Portfolio
description: Portfolio.
- name: Statements
description: Statements.
- name: Metadata
description: Metadata.
- name: Webhooks
description: Webhooks.
paths:
/core/kyb/associated-persons:
post:
tags:
- KYB
summary: Create associated person
description: Create a new associated person for a business user.
operationId: core.create-kyb-associated-person
requestBody:
$ref: '#/components/requestBodies/create-kyb-associated-person-type-request'
responses:
'201':
$ref: '#/components/responses/create-kyb-associated-person-type-response'
'409':
$ref: >-
#/components/responses/create-kyb-associated-person-type-conflict-response
security:
- OAuth2:
- core.kyb.associated-persons:create
components:
requestBodies:
create-kyb-associated-person-type-request:
content:
application/json:
schema:
type: object
discriminator:
propertyName: type
mapping:
beneficial-owner:
$ref: >-
#/components/schemas/create-kyb-associated-person-type-beneficial-owner
authorized-signer:
$ref: >-
#/components/schemas/create-kyb-associated-person-type-authorized-signer
beneficial-owner-and-authorized-signer:
$ref: >-
#/components/schemas/create-kyb-associated-person-type-beneficial-owner-and-authorized-signer
oneOf:
- $ref: >-
#/components/schemas/create-kyb-associated-person-type-beneficial-owner
title: Beneficial owner
- $ref: >-
#/components/schemas/create-kyb-associated-person-type-authorized-signer
title: Authorized signer
- $ref: >-
#/components/schemas/create-kyb-associated-person-type-beneficial-owner-and-authorized-signer
title: Beneficial owner and authorized signer
examples:
Beneficial Owner With Partial Details:
value:
type: beneficial-owner
fullName: Jane Smith
role: CFO
Beneficial Owner With Full Details:
value:
type: beneficial-owner
fullName: John Doe
role: CEO
address:
line1: 123 Main St
line2: Suite 100
city: Anytown
postalCode: '12345'
subdivision: US-CA
country: US
birthdate: '1980-01-01'
legalIds:
- type: tax-id
id: '123456789'
country: US
ownershipPercentage: 51
Type Only:
value:
type: beneficial-owner
responses:
create-kyb-associated-person-type-response:
description: Associated person created successfully.
content:
application/json:
schema:
type: object
properties:
associatedPerson:
$ref: '#/components/schemas/kyb-associated-person'
required:
- associatedPerson
examples:
Associated Person Created:
value:
associatedPerson:
id: 123e4567-e89b-12d3-a456-426614174000
processes:
profile:
code: profile
status: pending
input:
type: beneficial-owner
fullName: John Doe
role: CEO
identity:
code: identity
status: pending
type: none
proofOfAddress:
code: proof-of-address
status: pending
type: none
createdAt: '2024-01-01T00:00:00Z'
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
create-kyb-associated-person-type-conflict-response:
description: Business logic error.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Maximum Associated Persons Limit Exceeded:
value:
code: operation_not_allowed
message: The maximum number of associated persons has been reached
details:
reasons:
- maximum-associated-persons-limit-exceeded
Address Country Not Supported:
value:
code: country_not_supported
message: The country is not supported
details:
context: body
property: address.country
Address Subdivision Not Supported:
value:
code: subdivision_not_supported
message: The subdivision is not supported
details:
context: body
property: address.subdivision
Address PO Boxes Not Allowed:
value:
code: po_boxes_not_allowed
message: PO boxes are not allowed
details:
context: body
property: address
Address Postal Code Invalid:
value:
code: postal_code_invalid
message: The postal code is invalid
details:
context: body
property: address.postalCode
Invalid Birthdate:
value:
code: date_invalid
message: The date must be in the past
details:
context: body
property: birthdate
rule: difference-greater-than-threshold
threshold:
limit: 0
unit: milliseconds
Legal ID Country Not Supported:
value:
code: country_not_supported
message: The country is not supported
details:
context: body
property: legalIds[0].country
Legal Id Document Number Invalid:
value:
code: document_number_invalid
message: Tax ID is invalid for country 'US'
details:
context: body
property: legalIds[0].id
Full Name Contains Invalid Characters:
value:
code: invalid_characters
message: The request has invalid characters
details:
context: body
property: fullName
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
schemas:
create-kyb-associated-person-type-beneficial-owner:
type: object
properties:
type:
type: string
const: beneficial-owner
required:
- type
allOf:
- $ref: '#/components/schemas/create-kyb-associated-person-base'
- type: object
properties:
ownershipPercentage:
description: The ownership percentage for this beneficial owner.
type: number
exclusiveMinimum: 0
maximum: 100
create-kyb-associated-person-type-authorized-signer:
type: object
unevaluatedProperties: false
properties:
type:
type: string
const: authorized-signer
required:
- type
allOf:
- $ref: '#/components/schemas/create-kyb-associated-person-base'
create-kyb-associated-person-type-beneficial-owner-and-authorized-signer:
type: object
required:
- type
properties:
type:
type: string
const: beneficial-owner-and-authorized-signer
allOf:
- $ref: '#/components/schemas/create-kyb-associated-person-base'
- type: object
properties:
ownershipPercentage:
description: The ownership percentage for this beneficial owner.
type: number
exclusiveMinimum: 0
maximum: 100
kyb-associated-person:
type: object
properties:
id:
description: The unique identifier for the associated person.
type: string
format: uuid
processes:
$ref: '#/components/schemas/kyb-associated-person-processes'
createdAt:
description: The date and time when the associated person was created.
type: string
format: date-time
required:
- id
- processes
- createdAt
error:
description: The error information.
allOf:
- $ref: '#/components/schemas/feedback'
create-kyb-associated-person-base:
type: object
properties:
fullName:
allOf:
- $ref: '#/components/schemas/string-at-least-two-words-no-edge-spaces'
- description: The full legal name.
type: string
maxLength: 200
role:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: The person's role in the business (e.g., CFO, CEO).
type: string
minLength: 1
maxLength: 140
address:
allOf:
- $ref: '#/components/schemas/address-for-request'
- description: The person's address of residency.
birthdate:
description: The date of birth.
type: string
format: date
birthplace:
description: The place of birth.
type: object
properties:
town:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: The town of birth.
type: string
minLength: 1
maxLength: 100
country:
allOf:
- $ref: '#/components/schemas/country-code-for-request'
- description: The country of birth.
legalIds:
description: The legal identifiers.
type: array
maxItems: 20
items:
type: object
properties:
type:
description: The type of legal ID.
type: string
enum:
- tax-id
id:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: The legal ID value.
type: string
maxLength: 140
country:
allOf:
- $ref: '#/components/schemas/country-code-for-request'
- description: The country that issued the legal ID.
required:
- type
- id
- country
kyb-associated-person-processes:
description: The processes for an associated person.
type: object
properties:
profile:
$ref: '#/components/schemas/kyb-associated-person-profile'
identity:
$ref: '#/components/schemas/kyb-associated-person-identity'
proofOfAddress:
$ref: '#/components/schemas/kyb-associated-person-proof-of-address'
required:
- profile
- identity
- proofOfAddress
feedback:
description: A feedback message with a code and human-readable description.
type: object
properties:
code:
description: A short string with a brief explanation about the code reported.
type: string
message:
description: A human-readable message providing more details.
type: string
details:
description: Additional information about the feedback reported.
type: object
additionalProperties: true
required:
- code
- message
string-at-least-two-words-no-edge-spaces:
type: string
pattern: ^\S+\s+\S+(\s+\S+)*$
string-no-edge-spaces:
type: string
pattern: ^\S.*\S$|^\S$
address-for-request:
description: The address information.
type: object
additionalProperties: false
minProperties: 1
properties:
country:
allOf:
- $ref: '#/components/schemas/country-code-for-request'
- description: The country of the address.
subdivision:
allOf:
- $ref: '#/components/schemas/subdivision-code-for-request'
- description: The subdivision of the address.
city:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: The city of the address.
type: string
maxLength: 100
line1:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: The first line of the address.
type: string
maxLength: 150
line2:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: The second line of the address.
type: string
maxLength: 100
postalCode:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: The postal code of the address.
type: string
maxLength: 20
country-code-for-request:
type: string
pattern: ^[A-Z]{2}$
kyb-associated-person-profile:
description: The profile process for an associated person.
type: object
properties:
code:
description: The code of the KYB process.
type: string
const: profile
status:
$ref: '#/components/schemas/kyb-process-status'
input:
type: object
discriminator:
propertyName: type
mapping:
beneficial-owner:
$ref: >-
#/components/schemas/kyb-associated-person-profile-input-beneficial-owner
authorized-signer:
$ref: >-
#/components/schemas/kyb-associated-person-profile-input-authorized-signer
beneficial-owner-and-authorized-signer:
$ref: >-
#/components/schemas/kyb-associated-person-profile-input-beneficial-owner-and-authorized-signer
oneOf:
- $ref: >-
#/components/schemas/kyb-associated-person-profile-input-beneficial-owner
- $ref: >-
#/components/schemas/kyb-associated-person-profile-input-authorized-signer
- $ref: >-
#/components/schemas/kyb-associated-person-profile-input-beneficial-owner-and-authorized-signer
required:
- code
- status
kyb-associated-person-identity:
type: object
discriminator:
propertyName: type
mapping:
none:
$ref: '#/components/schemas/kyb-associated-person-identity-none'
document-submission:
$ref: >-
#/components/schemas/kyb-associated-person-identity-document-submission
oneOf:
- $ref: '#/components/schemas/kyb-associated-person-identity-none'
title: None
- $ref: >-
#/components/schemas/kyb-associated-person-identity-document-submission
title: Document submission
kyb-associated-person-proof-of-address:
type: object
discriminator:
propertyName: type
mapping:
none:
$ref: '#/components/schemas/kyb-associated-person-proof-of-address-none'
document-submission:
$ref: >-
#/components/schemas/kyb-associated-person-proof-of-address-document-submission
oneOf:
- $ref: '#/components/schemas/kyb-associated-person-proof-of-address-none'
title: None
- $ref: >-
#/components/schemas/kyb-associated-person-proof-of-address-document-submission
title: Document submission
subdivision-code-for-request:
type: string
pattern: ^[A-Z]{2}-[A-Z0-9]{1,3}$
kyb-process-status:
description: Status of the KYB process.
type: string
enum:
- ok
- failed
- running
- pending
- exempt
kyb-associated-person-profile-input-beneficial-owner:
description: Request to create a beneficial owner.
allOf:
- $ref: '#/components/schemas/kyb-associated-person-profile-input-base'
- type: object
properties:
type:
type: string
const: beneficial-owner
ownershipPercentage:
description: The ownership percentage for this beneficial owner.
type: number
exclusiveMinimum: 0
maximum: 100
required:
- type
kyb-associated-person-profile-input-authorized-signer:
description: Request to create an authorized signer.
allOf:
- $ref: '#/components/schemas/kyb-associated-person-profile-input-base'
- type: object
properties:
type:
type: string
const: authorized-signer
required:
- type
kyb-associated-person-profile-input-beneficial-owner-and-authorized-signer:
description: Request to create a beneficial owner and authorized signer.
allOf:
- $ref: '#/components/schemas/kyb-associated-person-profile-input-base'
- type: object
properties:
type:
type: string
const: beneficial-owner-and-authorized-signer
ownershipPercentage:
description: The ownership percentage for this beneficial owner.
type: number
exclusiveMinimum: 0
maximum: 100
required:
- type
kyb-associated-person-identity-none:
title: None
description: The identity process for an associated person.
type: object
properties:
code:
description: The code of the KYB process.
type: string
const: identity
status:
$ref: '#/components/schemas/kyb-process-status'
type:
description: The identity submission type.
type: string
enum:
- none
required:
- code
- status
- type
kyb-associated-person-identity-document-submission:
title: Document Submission
description: The identity process for an associated person.
type: object
properties:
code:
description: The code of the KYB process.
type: string
const: identity
status:
$ref: '#/components/schemas/kyb-process-status'
type:
description: The identity submission type.
type: string
enum:
- document-submission
input:
description: Input of the KYB process.
type: object
properties:
media:
description: The media that was used to verify the identity.
type: array
items:
type: object
properties:
context:
description: The context of the file.
type: string
enum:
- document-front
- document-back
fileId:
description: The id of the file.
type: string
format: uuid
output:
description: Output of the KYB process.
type: object
properties:
provider:
description: The provider used to verify the KYB process.
type: string
reason:
description: The reason associated with the verification.
type: string
enum:
- data-mismatch
- document-expired
- document-not-readable
- duplicate
- missing-declared-information
- underage
- timeout
- unknown
document:
description: The identity document information.
type: object
properties:
type:
description: The type of the document.
type: string
enum:
- driving-license
- id-card
- passport
- residence-permit
- unsupported
number:
description: The number of the document.
type: string
country:
description: The country of the document.
type: string
expiresAt:
description: The expiration date of the document.
type: string
format: date
required:
- type
- number
- country
person:
description: The person information.
type: object
properties:
givenName:
description: The person's given name.
type: string
familyName:
description: The person's family name or surname.
type: string
birthdate:
description: The date of birth.
type: string
format: date
gender:
description: The gender.
type: string
enum:
- female
- male
address:
allOf:
- $ref: '#/components/schemas/address'
- type: object
required:
- country
required:
- givenName
- birthdate
verifiedAt:
description: The date and time of the verification.
type: string
format: date-time
required:
- provider
required:
- code
- status
- type
kyb-associated-person-proof-of-address-none:
title: None
description: The proof-of-address process for an associated person.
type: object
properties:
code:
description: The code of the KYB process.
type: string
const: proof-of-address
status:
$ref: '#/components/schemas/kyb-process-status'
type:
description: The proof-of-address submission type.
type: string
enum:
- none
required:
- code
- status
- type
kyb-associated-person-proof-of-address-document-submission:
title: Document Submission
description: The proof-of-address process for an associated person.
type: object
properties:
code:
description: The code of the KYB process.
type: string
const: proof-of-address
status:
$ref: '#/components/schemas/kyb-process-status'
type:
description: The proof-of-address submission type.
type: string
enum:
- document-submission
input:
description: Input of the KYB process.
type: object
properties:
media:
description: The media that was used to verify the address.
type: array
items:
type: object
properties:
context:
description: The context of the file.
type: string
enum:
- address-proof
fileId:
description: The id of the file.
type: string
format: uuid
output:
description: Output of the KYB process.
type: object
properties:
provider:
description: The provider used to verify the KYB process.
type: string
reason:
description: The reason associated with the verification.
type: string
enum:
- address-mismatch
- name-mismatch
person:
description: The person information.
type: object
properties:
givenName:
description: The person's given name.
type: string
familyName:
description: The person's family name or surname.
type: string
address:
allOf:
- $ref: '#/components/schemas/address'
- type: object
required:
- country
required:
- givenName
- address
verifiedAt:
description: The date and time of the verification.
type: string
format: date-time
required:
- provider
- person
- verifiedAt
required:
- code
- status
- type
kyb-associated-person-profile-input-base:
type: object
properties:
fullName:
description: The full name of the associated person.
type: string
role:
description: The role of the associated person in the business (e.g., CFO, CEO).
type: string
address:
allOf:
- $ref: '#/components/schemas/address'
- description: The address of the associated person.
birthdate:
description: The birthdate of the associated person.
type: string
format: date
birthplace:
description: The place of birth of the associated person.
type: object
properties:
town:
description: The town of birth.
type: string
country:
description: The country of birth.
type: string
required:
- town
- country
legalIds:
description: The legal identifiers of the associated person.
type: array
items:
type: object
properties:
type:
description: The type of the legal identifier.
type: string
enum:
- tax-id
country:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: The country that issued the tax ID.
type: string
id:
allOf:
- $ref: '#/components/schemas/string-no-edge-spaces'
- description: The tax ID value.
type: string
required:
- country
- id
address:
description: The address information.
type: object
properties:
country:
description: The country of the address.
type: string
subdivision:
description: The subdivision of the address.
type: string
city:
description: The city of the address.
type: string
line1:
description: The first line of the address.
type: string
line2:
description: The second line of the address.
type: string
postalCode:
description: The postal code of the address.
type: string
securitySchemes:
OAuth2:
type: oauth2
description: OAuth 2.0 authentication.
flows:
clientCredentials:
tokenUrl: /core/oauth2/token
scopes:
core.users:act-on-behalf-of: Grants access to act on behalf of a user
core.users:create: Grants access to create users
core.users:read: Grants access to view users
core.users:delete: Grants access to delete users
core.users.metadata:read: Grants access to view user metadata
core.users.metadata:write: Grants access to modify user metadata
core.kyc:read: Grants access to view KYC processes
core.kyc.profile:update: Grants access to update profile KYC process
core.kyc.address:update: Grants access to update address KYC process
core.kyc.email:update: Grants access to update email KYC process
core.kyc.phone:update: Grants access to update phone KYC process
core.kyc.identity:update: Grants access to update identity KYC process
core.kyc.proof-of-address:update: Grants access to update proof-of-address KYC process
core.kyc.customer-due-diligence:update: Grants access to update customer due diligence KYC process
core.kyc.enhanced-due-diligence:update: Grants access to update enhanced due diligence KYC process
core.kyc.crypto-risk-assessment:update: Grants access to update crypto risk assessment KYC process
core.kyc.self-categorization-statement:update: Grants access to update self-categorization statement KYC process
core.kyc.tax-details:update: Grants access to update tax details KYC process
core.kyb:read: Grants access to view KYB processes
core.kyb.profile:update: Grants access to update profile KYB process
core.kyb.documents:update: Grants access to update documents KYB process
core.kyb.financial-institution:update: Grants access to update financial institution KYB process
core.kyb.associated-persons:create: Grants access to create KYB associated persons
core.kyb.associated-persons:read: Grants access to view KYB associated persons
core.kyb.associated-persons:delete: Grants access to delete KYB associated persons
core.kyb.associated-persons.profile:update: Grants access to update profile KYB associated person process
core.kyb.associated-persons.identity:update: Grants access to update identity KYB associated person process
core.kyb.associated-persons.proof-of-address:update: >-
Grants access to update proof-of-address KYB associated person
process
core.kyb.attestation:trigger: Grants access to trigger the attestation process
core.capabilities:read: Grants access to view user capabilities
core.terms-of-service:read: Grants access to view terms of service
core.terms-of-service:accept: Grants access to accept terms of service
core.files:create: Grants access to create files
core.files:read: Grants access to view files
core.files.metadata:read: Grants access to view files metadata
core.files.metadata:write: Grants access to modify files metadata
core.accounts:create: Grants access to create accounts
core.accounts:read: Grants access to view accounts
core.accounts:update: Grants access to update accounts
core.accounts:archive: Grants access to archive accounts
core.accounts:deposit-method: >-
Grants access to deposit method needed for depositing into
accounts
core.accounts:use-test-helpers: Grants access to test helpers of accounts
core.accounts.metadata:read: Grants access to view accounts metadata
core.accounts.metadata:write: Grants access to modify accounts metadata
core.assets:use-test-helpers: Grants access to test helpers of assets
core.external-accounts:create: Grants access to create external accounts
core.external-accounts:read: Grants access to view external accounts
core.external-accounts:update: Grants access to update external accounts
core.external-accounts:delete: Grants access to delete external accounts
core.external-accounts.metadata:read: Grants access to view external accounts metadata
core.external-accounts.metadata:write: Grants access to modify external accounts metadata
core.transactions:create: Grants access to commit quotes
core.transactions:read: Grants access to view transactions
core.transactions.metadata:read: Grants access to view transactions metadata
core.transactions.metadata:write: Grants access to modify transactions metadata
core.transactions.requests-for-information:read: Grants access to view transactions requests for information
core.transactions.requests-for-information:update: Grants access to update transactions requests for information
core.portfolio:read: >-
Grants access to view portfolio overview, performance, and
historical balance
core.statements:read: Grants access to read statements
core.webhooks:management-link: Grants access to create webhook management links
````