Skip to main content
GET
/
api
/
external
/
companies
/
{companyId}
/
payees
/
{payeeId}
Get Payee
curl --request GET \
  --url https://app.aiinsurance.io/api/external/companies/{companyId}/payees/{payeeId} \
  --header 'Authorization: <api-key>'
import requests

url = "https://app.aiinsurance.io/api/external/companies/{companyId}/payees/{payeeId}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.aiinsurance.io/api/external/companies/{companyId}/payees/{payeeId}', 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://app.aiinsurance.io/api/external/companies/{companyId}/payees/{payeeId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://app.aiinsurance.io/api/external/companies/{companyId}/payees/{payeeId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://app.aiinsurance.io/api/external/companies/{companyId}/payees/{payeeId}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.aiinsurance.io/api/external/companies/{companyId}/payees/{payeeId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "companyId": "660e8400-e29b-41d4-a716-446655440000",
  "name": "Smith & Associates Law Firm",
  "payeeType": "lawFirm",
  "email": "contact@smithlaw.com",
  "alternateEmails": [
    "billing@smithlaw.com"
  ],
  "phoneNumber": "+1-555-123-4567",
  "description": "Defense law firm specializing in insurance litigation",
  "address": "123 Legal Plaza, Suite 500, New York, NY 10001",
  "addressStructured": {
    "streetNumber": "123",
    "streetName": "Legal Plaza",
    "city": "New York",
    "state": {
      "short": "NY",
      "long": "New York"
    },
    "postalCode": "10001",
    "country": "US"
  },
  "lawFirmType": "defense",
  "bankInfo": {
    "bankAccountNumber": "****1234",
    "bankRoutingNumber": "****5678"
  },
  "taxIdNumber": "12-3456789",
  "externalPayee": null,
  "createdAt": "2025-01-15T10:30:00.000Z",
  "createdBy": "880e8400-e29b-41d4-a716-446655440000",
  "updatedAt": "2025-01-16T14:20:00.000Z",
  "updatedBy": "880e8400-e29b-41d4-a716-446655440000"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

companyId
string<uuid>
required

Company identifier

payeeId
string<uuid>
required

Payee identifier

Response

Payee details

A payee entity (law firm, expert, vendor, etc.)

id
string<uuid>

Payee identifier

companyId
string<uuid> | null

Company identifier

name
string

Payee name

payeeType
enum<string>

Type of payee

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

Primary email address

alternateEmails
string<email>[] | null

Additional email addresses

phoneNumber
string | null

Phone number

description
string | null

Description of the payee

address
string | null

Unstructured address string

addressStructured
object | null

Structured address with parsed components

lawFirmType
enum<string> | null

Type of law firm (only for payeeType lawFirm)

Available options:
defense,
plaintiff
bankInfo
object | null

Bank account information

taxIdNumber
string | null

Tax identification number

externalPayee
object | null

Reference to payee in external system

createdAt
string<date-time> | null

When the payee was created (ISO 8601)

createdBy
string<uuid> | null

User ID who created the payee

updatedAt
string<date-time> | null

When the payee was last updated (ISO 8601)

updatedBy
string<uuid> | null

User ID who last updated the payee