Skip to main content
PATCH
Update a company

Authorizations

Api-Key
string
header
required

Path Parameters

companyId
string<uuid>
required

Id of the company to update

Body

application/json

The updates to apply to the company

externalId
string

An optional tenant-defined identifier for this company. Must be unique within the tenant.

Required string length: 1 - 255
name
string

The company's name on the Rain platform

address
object

The company's physical address

Response

Successful operation

id
string<uuid>
required

The company's unique identifier

name
string
required

The company's name on the Rain platform

address
object
required

The company's physical address

applicationStatus
enum<string>
required
Available options:
approved,
pending,
needsInformation,
needsVerification,
manualReview,
denied,
locked,
canceled
externalId
string

An optional tenant-defined identifier for this company. Must be unique within the tenant.

Required string length: 1 - 255
sourceKey
string

The source key associated with the company's team

Required string length: 1 - 24
ultimateBeneficialOwners
object[]

The company's ultimate beneficial owners

The link to the external verification page for the application

The link to the completion page for the application

applicationReason
string

The reason for the application status