Skip to main content
POST
/
api
/
external
/
companies
/
{companyId}
/
payees
curl --request POST \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/payees \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Expert Forensics Inc",
  "payeeType": "expert"
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440003"
}

Authorizations

​
Authorization
string
header
required

Use format: ApiKey <your-api-key>

Path Parameters

​
companyId
string<uuid>
required

Company identifier

Body

application/json

Request body for creating a payee

​
name
string
required

Payee name (required)

​
payeeType
enum<string>
required

Type of payee

Available options:
lawFirm,
expert,
vendor,
other,
financingCompany
​
email
string<email>

Primary email address

​
alternateEmails
string<email>[]

Additional email addresses

​
phoneNumber
string

Phone number

​
description
string

Description of the payee

​
address
string

Unstructured address string

​
addressStructured
object

Structured address with parsed components (payee-specific format)

​
lawFirmType
enum<string>

Type of law firm (only applicable when payeeType is lawFirm)

Available options:
defense,
plaintiff
​
bankInfo
object

Bank account information for payments

​
taxIdNumber
string

Tax identification number

Response

Payee created successfully

​
id
string<uuid>

The ID of the created payee