Create Payee - AI Insurance

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" } '

Authorizations

Authorization

string

header

required

API key authentication. Include your API key in the Authorization header.

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

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)

Show child attributes

lawFirmType

enum<string>

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

Available options:

defense,

plaintiff

bankInfo

object

Bank account information for payments

Show child attributes

taxIdNumber

string

Tax identification number

Response

Payee created successfully

string<uuid>

The ID of the created payee