### Palm API Versioning Example

Source: https://docs.getpalm.com/api-reference/introduction

API version numbers are included in the URL path. This example shows the structure for a request to the business registry search endpoint.

```http
https://api.getpalm.com/v1/business/registry/search
```

--------------------------------

### Verify EIN Request Example

Source: https://docs.getpalm.com/api-reference/v1/verification/verify-tin

Example of a request to verify an Employer Identification Number (EIN) and associated business name.

```json
{
  "tin": "12-3456789",
  "tin_type": "ein",
  "name": "Acme Corporation",
  "reference_id": "tin_req_12345"
}
```

--------------------------------

### Verify SSN Request Example

Source: https://docs.getpalm.com/api-reference/v1/verification/verify-tin

Example of a request to verify a Social Security Number (SSN) and associated individual name.

```json
{
  "tin": "123-45-6789",
  "tin_type": "ssn",
  "name": "Jane Doe",
  "reference_id": "tin_req_12346"
}
```

--------------------------------

### List Businesses for a User (OpenAPI)

Source: https://docs.getpalm.com/api-reference/v1/user/list-businesses-for-a-user

This OpenAPI definition describes the GET request to list businesses for a user. It specifies the path parameter `user_id` and the expected responses.

```yaml
openapi: 3.0.0
info:
  title: Palm Partner API
  description: >-
    The Palm Partner API provides a comprehensive platform for KYC (Know Your
    Customer) and KYB (Know Your Business) verification, identity management,
    and financial data aggregation.
  version: '1.0'
  contact:
    name: Palm Support
    url: https://getpalm.com
    email: support@getpalm.com
  termsOfService: https://getpalm.com/terms
  license:
    name: Proprietary
    url: https://getpalm.com/license
servers:
  - url: https://api.getpalm.com
    description: Production
security: []
tags:
  - name: Registry
    description: Search business registries
  - name: Verification
    description: Identity and business verification
  - name: Monitor
    description: Continuous monitoring of businesses
  - name: Business
    description: Business entity management
  - name: User
    description: User identity management
paths:
  /v1/user/{user_id}/business:
    get:
      tags:
        - User
      summary: List businesses for a user
      description: Returns all businesses where this user is listed as a beneficial owner.
      operationId: getUserBusinesses
      parameters:
        - name: user_id
          required: true
          in: path
          description: User ID
          schema:
            example: palm_usr_1a2b3c4d5e6f7g8h
            type: string
      responses:
        '200':
          description: List of businesses retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimpleList'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '429':
          description: Rate Limited
        '500':
          description: Server Error
      security:
        - ApiKey: []
components:
  schemas:
    SimpleList:
      type: object
      properties:
        object:
          type: string
          description: Object type identifier, always "list"
          enum:
            - list
          example: list
        data:
          description: Array of resources
          type: array
          items:
            type: array
      required:
        - object
        - data
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: 'Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx'

```

--------------------------------

### Specific Business Registration Response Example

Source: https://docs.getpalm.com/onboard/registry-search

This response provides a detailed record including principal and mailing addresses, standing information, fictitious names, industry codes, and associated people or entities.

```json
{
  "palm_id": "1234-5678-9012",
  "name": "Acme Corp",
  "formation_date": "2020-03-15",
  "formation_jurisdiction": "US-DE",
  "registration_jurisdiction": "US-CA",
  "status": "active",
  "entity_type": "llc",
  "registration_number": "202012345678",
  "principal_address": {
    "country": "US",
    "street_line_1": "100 Main Street",
    "street_line_2": "Suite 200",
    "city": "San Francisco",
    "region": "CA",
    "postal_code": "94105"
  },
  "mailing_address": {
    "country": "US",
    "street_line_1": "100 Main Street",
    "street_line_2": "Suite 200",
    "city": "San Francisco",
    "region": "CA",
    "postal_code": "94105"
  },
  "standing": {
    "registration": "compliant",
    "tax": "compliant",
    "agent": "compliant"
  },
  "fictitious_names": ["DBA Name LLC"],
  "industry_codes": [
    {
      "code": "541511",
      "type": "naics",
      "description": "Custom Computer Programming Services"
    }
  ],
  "associates": [
    {
      "role": "agent",
      "name": "John Smith",
      "type": "person",
      "title": "Registered Agent",
      "address": {
        "country": "US",
        "street_line_1": "100 Main Street",
        "street_line_2": "Suite 200",
        "city": "San Francisco",
        "region": "CA",
        "postal_code": "94105"
      }
    },
    {
      "role": "member",
      "name": "Jane Doe",
      "type": "person",
      "title": "Managing Member"
    }
  ]
}
```

--------------------------------

### Example TIN Verification Request

Source: https://docs.getpalm.com/verify/verify-a-tin

Use this cURL command to send a POST request to the TIN verification endpoint. Ensure you replace 'sk_test_...' with your actual API key and adjust the payload as needed for EIN or SSN verification.

```bash
curl -X POST https://api.getpalm.com/v1/tin/verification \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sk_test_...' \
  -d '{
    "tin": "12-3456789",
    "tin_type": "ein",
    "name": "Acme Corporation",
    "reference_id": "tin_req_12345"
  }'
```

--------------------------------

### Get Specific Business Registration

Source: https://docs.getpalm.com/onboard/registry-search

If you have the jurisdiction and registration number, you can look up a specific business directly using a GET request to the /v1/business/registry/{jurisdiction}/{registration_number} endpoint. This returns a more detailed record than the search endpoint.

```bash
curl -X GET https://api.getpalm.com/v1/business/registry/US-CA/C1234567 \
  -H 'Authorization: Bearer sk_test_...'
```

--------------------------------

### Registry Search Response Example

Source: https://docs.getpalm.com/onboard/registry-search

A successful search returns a list of matching business entities. The 'status' field indicates if the business is currently recognized by the state, and 'registration_number' is the state-assigned identifier.

```json
{
  "object": "list",
  "data": [
    {
      "palm_id": "1234-5678-9012",
      "name": "Acme Corp",
      "formation_date": "2020-03-15",
      "formation_jurisdiction": "US-DE",
      "registration_jurisdiction": "US-CA",
      "status": "active",
      "entity_type": "llc",
      "registration_number": "202012345678",
      "principal_address": {
        "country": "US",
        "street_line_1": "100 Main Street",
        "street_line_2": "Suite 200",
        "city": "San Francisco",
        "region": "CA",
        "postal_code": "94105"
      }
    }
  ]
}
```

--------------------------------

### TIN Verification - Matched Response

Source: https://docs.getpalm.com/api-reference/v1/verification/verify-tin

Example response indicating that the provided EIN and name successfully matched IRS records.

```json
{
  "verification_id": "550e8400-e29b-41d4-a716-446655440000",
  "object": "tin_verification",
  "tin_type": "ein",
  "matched": true,
  "status": "completed",
  "reference_id": "tin_req_12345",
  "created_at": "2026-04-22T05:33:01.665Z",
  "verified_at": "2026-04-22T05:33:01.665Z"
}
```

--------------------------------

### Get Business from Registry

Source: https://docs.getpalm.com/api-reference/v1/registry/get-business-from-registry

Retrieve detailed business information from the registry by jurisdiction and registration number. Returns full business details including associates and standing information.

```APIDOC
## Get Business from Registry

### Description
Retrieve detailed business information from the registry by jurisdiction and registration number. Returns full business details including associates and standing information.

### Method
GET

### Endpoint
`/registry/business?jurisdiction={jurisdiction}&registrationNumber={registrationNumber}`

### Parameters
#### Query Parameters
- **jurisdiction** (string) - Required - The jurisdiction of the business.
- **registrationNumber** (string) - Required - The registration number of the business.
```

--------------------------------

### Add a Business

Source: https://docs.getpalm.com/api-reference/v1/business/add-a-business

Adds a business, customer, or applicant to Palm. This is a common first step when integrating with Palm. You can provide an optional display name, metadata, and vault data. Vault fields use the `business.*` key format (e.g., `business.legal_name`, `business.ein`). If you plan to file an EIN application, include the required vault fields: legal_name, entity_type, formation_jurisdiction, formation_date, address_line_1, city, region, and postal_code.

```APIDOC
## POST /v1/business

### Description
Add one of your businesses, customers or applicants to Palm. This is a common first step when integrating with Palm. Provide optional display name, metadata, and vault data. Vault fields use the `business.*` key format (e.g., `business.legal_name`, `business.ein`). If you plan to file an EIN application, include the required vault fields: legal_name, entity_type, formation_jurisdiction, formation_date, address_line_1, city, region, and postal_code.

### Method
POST

### Endpoint
/v1/business

### Request Body
- **metadata** (object) - Optional - Store up to 50 custom key-value pairs for application-specific data. Useful for storing references to external systems, feature flags, or other custom attributes.
- **display_name** (string) - Optional - Display name for the business
- **vault** (object) - Optional - Business data to store in the vault. Use vault field IDs as keys (e.g., "business.ein", "business.legal_name"). See BusinessVaultFieldsDto for the complete list of available fields.

### Request Example
```json
{
  "metadata": {
    "external_id": "user_789_in_my_system",
    "customer_tier": "standard",
    "signup_source": "web"
  },
  "display_name": "Acme Corp",
  "vault": {
    "business.legal_name": "Acme Corporation Inc.",
    "business.ein": "12-3456789",
    "business.entity_type": "llc",
    "business.registration_jurisdiction": "US-CA"
  }
}
```

### Response
#### Success Response (201)
- **id** (string) - Unique identifier for the resource
- **object** (string) - Object type identifier, always "business"
- **created_at** (string) - ISO 8601 timestamp of when the resource was created
- **updated_at** (string) - ISO 8601 timestamp of when the resource was last updated
- **metadata** (object) - Store up to 50 custom key-value pairs for application-specific data.
- **palm_id** (string) - Palm identifier for the business, used for monitoring and external integrations
- **status** (string) - Current status of the business
- **display_name** (string) - Display name for the business

#### Response Example
```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "business",
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "metadata": {
    "external_id": "user_123_in_my_system",
    "customer_tier": "premium",
    "signup_source": "mobile_app"
  },
  "palm_id": "1234-5678-9012",
  "status": "active",
  "display_name": "Acme Corp"
}
```
```

--------------------------------

### Verify existing business

Source: https://docs.getpalm.com/llms.txt

Initiates the verification process for an existing business.

```APIDOC
## POST /v1/business/verify-existing-business

### Description
Verifies an existing business.

### Method
POST

### Endpoint
/v1/business/verify-existing-business

### Parameters
#### Request Body
- **business_id** (string) - Required - The unique identifier of the business to verify.
```

--------------------------------

### Get Business Monitoring Subscription Status

Source: https://docs.getpalm.com/api-reference/v1/monitor/get-business-monitoring-subscription-status

Retrieve the current monitoring subscription status and configuration for a business.

```APIDOC
## GET /v1/business/{business_id}/subscription

### Description
Retrieve the current monitoring subscription status and configuration for a business.

### Method
GET

### Endpoint
/v1/business/{business_id}/subscription

### Parameters
#### Path Parameters
- **business_id** (string) - Required - Business ID

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the subscription
- **object** (string) - Object type identifier (enum: subscription)
- **resource_type** (string) - Type of resource being monitored (enum: user, business)
- **resource_id** (string) - ID of the user or business being monitored
- **event_types** (array) - List of webhook event types subscribed to for monitoring notifications
- **status** (string) - Current status of the subscription (enum: active, paused, expired, cancelled)
- **metadata** (object) - Custom metadata for the subscription
- **created_at** (string) - ISO 8601 timestamp when the subscription was created
- **updated_at** (string) - ISO 8601 timestamp when the subscription was last updated
- **expires_at** (string) - ISO 8601 timestamp when the subscription expires (for paid subscriptions) (nullable)

#### Response Example
```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "subscription",
  "resource_type": "business",
  "resource_id": "123e4567-e89b-12d3-a456-426614174000",
  "event_types": [
    "business.registration.updated",
    "business.filing.due"
  ],
  "status": "active",
  "metadata": {
    "customer_tier": "premium",
    "monitoring_level": "enhanced"
  },
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "expires_at": "2026-10-24T10:30:00Z"
}
```

#### Error Responses
- **401** - Unauthorized - Invalid or missing API key
- **404** - Subscription not found for this business
- **429** - Rate limit exceeded
- **500** - Internal server error
```

--------------------------------

### Verify Existing User

Source: https://docs.getpalm.com/api-reference/v1/user/verify-existing-user

Initiates the verification process for an existing user.

```APIDOC
## POST /v1/user/{user_id}/verification

### Description
Verifies an existing user's identity. This endpoint is used to re-initiate or continue a verification process for a user that already exists in the system.

### Method
POST

### Endpoint
/v1/user/{user_id}/verification

### Parameters
#### Path Parameters
- **user_id** (string) - Required - The unique identifier of the user to verify.

#### Request Body
- **workflow_key** (string) - Optional - The key of the workflow to use for verification. If not provided, the organization's default workflow is used.
- **reference_id** (string) - Optional - A custom reference ID for tracking this specific verification request.
- **metadata** (object) - Optional - Additional key-value pairs for metadata.

### Request Example
```json
{
  "workflow_key": "business_verification_default",
  "reference_id": "reverify_12345",
  "metadata": {
    "reason": "annual_review"
  }
}
```

### Response
#### Success Response (201)
- **user_id** (string) - The ID of the user entity.
- **verification_id** (string) - The unique ID for this verification.
- **reference_id** (string) - The reference ID provided in the request, if any.
- **status** (string) - The current status of the verification (e.g., pending, completed, failed).
- **risk** (object) - Risk assessment details.
- **match** (object) - Field-level match results.
- **synthetic** (object) - Results of synthetic identity detection.
- **velocity** (object) - Velocity check results.
- **device** (object) - Device intelligence information.
- **watchlist** (object) - Watchlist screening results.
- **created_at** (string) - ISO 8601 timestamp of when the verification was created.
- **updated_at** (string) - ISO 8601 timestamp of when the verification was last updated.

#### Response Example
```json
{
  "user_id": "550e8400-e29b-41d4-a716-446655440000",
  "verification_id": "660f9511-f30c-52e5-b827-557766551111",
  "reference_id": "user_12345",
  "status": "completed",
  "risk": {
    "level": "low"
  },
  "match": {},
  "synthetic": {},
  "velocity": {},
  "device": {},
  "watchlist": {},
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T10:35:00Z"
}
```
```

--------------------------------

### Get Business Monitoring Subscription Status

Source: https://docs.getpalm.com/api-reference/v1/monitor/get-business-monitoring-subscription-status

Retrieve the current monitoring subscription status and configuration for a business.

```APIDOC
## Get Business Monitoring Subscription Status

### Description
Retrieve the current monitoring subscription status and configuration for a business.

### Method
GET

### Endpoint
/v1/monitor/subscription-status

### Parameters
#### Query Parameters
- **business_id** (string) - Required - The unique identifier of the business.

### Response
#### Success Response (200)
- **status** (string) - The current subscription status (e.g., 'active', 'inactive', 'trial').
- **configuration** (object) - An object containing the subscription configuration details.
  - **feature_a** (boolean) - Indicates if feature A is enabled.
  - **feature_b** (boolean) - Indicates if feature B is enabled.

#### Response Example
{
  "status": "active",
  "configuration": {
    "feature_a": true,
    "feature_b": false
  }
}
```

--------------------------------

### Validation Error - Missing TIN Type

Source: https://docs.getpalm.com/api-reference/v1/verification/verify-tin

Example error response for a missing required `tin_type` field in the request.

```json
{
  "type": "https://api.getpalm.com/problems/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "instance": "/tin/verification",
  "errors": [
    {
      "field": "unknown",
      "message": "Required field 'tin_type' is missing."
    }
  ]
}
```

--------------------------------

### Authentication

Source: https://docs.getpalm.com/api-reference/v1/user/create-a-new-user

Describes the API authentication method using Bearer JWT tokens, typically starting with 'sk_test_' or 'sk_live_'.

```APIDOC
## Authentication

### Scheme: ApiKey

- **Type**: `http`
- **Scheme**: `bearer`
- **Bearer Format**: `JWT`
- **Description**: Enter your API key in the format: `sk_test_xxxxx` or `sk_live_xxxxx`.
```

--------------------------------

### Verify a Person Request

Source: https://docs.getpalm.com/verify/verify-a-person

Send a POST request to the /v1/user/verification endpoint with the person's details to initiate verification. Ensure you include the workflow_key and essential personal information.

```bash
curl -X POST https://api.getpalm.com/v1/user/verification \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sk_test_...' \
  -d '{
    "workflow_key": "user_verification_default",
    "first_name": "Jane",
    "last_name": "Smith",
    "date_of_birth": "1985-03-15",
    "ssn": "123-45-6789",
    "address_line_1": "100 Main Street",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105"
  }'
```

--------------------------------

### TIN Verification - Not Matched Response

Source: https://docs.getpalm.com/api-reference/v1/verification/verify-tin

Example response indicating that the EIN was found, but the provided name did not match IRS records.

```json
{
  "verification_id": "8f14e45f-ceea-467a-9575-2b0b8f1b1f01",
  "object": "tin_verification",
  "tin_type": "ein",
  "matched": false,
  "status": "completed",
  "reference_id": "tin_req_12345",
  "created_at": "2026-04-22T05:33:01.665Z",
  "verified_at": "2026-04-22T05:33:01.665Z"
}
```

--------------------------------

### Verify a Business Request

Source: https://docs.getpalm.com/verify/verify-a-business

Send a POST request to the /v1/business/verification endpoint with the minimum required fields: workflow_key, legal_name, and region. Additional fields can be included to improve match accuracy.

```Bash
curl -X POST https://api.getpalm.com/v1/business/verification \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sk_test_...' \
  -d '{
    "workflow_key": "business_verification_default",
    "legal_name": "Acme Corporation",
    "region": "US-CA"
  }'
```

--------------------------------

### Get Icon Props

Source: https://docs.getpalm.com/get-started/get-access

Returns a CSS class name for an icon based on the variant. Defaults to 'palm-icon-default' if the variant is not found.

```javascript
export const iconProps = (variant = "default") => {
  const iconVariants = {
    default: "palm-icon-default",
    horizontal: "palm-icon-horizontal",
    stack: "palm-icon-stack",
    navigation: "palm-icon-navigation",
    darkHorizontal: "palm-icon-dark-horizontal",
    dark_stack: "palm-icon-dark-stack",
    getStarted: "palm-icon-get-started"
  };
  return iconVariants[variant] ?? iconVariants.default;
};
```

--------------------------------

### Validation Error - Invalid EIN Format

Source: https://docs.getpalm.com/api-reference/v1/verification/verify-tin

Example error response for an invalid EIN format, indicating it must be 9 digits.

```json
{
  "type": "https://api.getpalm.com/problems/validation_error",
  "title": "Validation Error",
  "status": 400,
  "detail": "Request validation failed",
  "instance": "/tin/verification",
  "errors": [
    {
      "field": "unknown",
      "message": "Invalid EIN format: must be 9 digits, got 5"
    }
  ]
}
```

--------------------------------

### Verify a Business

Source: https://docs.getpalm.com/verify/verify-a-business

Initiates a new business verification process. Requires a workflow key, legal name, and region. Additional fields can be included for improved accuracy.

```APIDOC
## POST /v1/business/verification

### Description
Send a `POST` request to `/v1/business/verification` to initiate a business verification.

### Method
POST

### Endpoint
https://api.getpalm.com/v1/business/verification

### Parameters
#### Request Body
- **workflow_key** (string) - Required - The key for the verification workflow.
- **legal_name** (string) - Required - The legal name of the business.
- **region** (string) - Required - The region of the business (e.g., US-CA).
- **ein** (string) - Optional - Employer Identification Number.
- **entity_type** (string) - Optional - The type of business entity.
- **formation_jurisdiction** (string) - Optional - The jurisdiction where the business was formed.
- **address** (object) - Optional - The business address.
- **associates** (array) - Optional - A list of associates (beneficial owners) to verify inline.

### Request Example
```json
{
  "workflow_key": "business_verification_default",
  "legal_name": "Acme Corporation",
  "region": "US-CA"
}
```

### Response
#### Success Response (200)
- **business_id** (string) - The unique identifier for the business.
- **verification_id** (string) - The unique identifier for this verification.
- **status** (string) - The status of the verification (e.g., `completed`).
- **risk** (object) - Risk assessment details.
  - **level** (string) - The risk level (e.g., `low`).
  - **reasons** (array) - Reasons for the risk level.
- **match** (object) - Match results for the verified fields.
  - **legal_name** (string) - Match status for legal name.
  - **region** (string) - Match status for region.
  - **ein** (string) - Match status for EIN.
- **associates** (array) - KYC results for each verified owner, if included.
- **created_at** (string) - The timestamp when the verification was created.

#### Response Example
```json
{
  "business_id": "biz_4c7e1a...",
  "verification_id": "ver_8a3f2b...",
  "status": "completed",
  "risk": { "level": "low", "reasons": [] },
  "match": {
    "legal_name": "match",
    "region": "match",
    "ein": "match"
  },
  "associates": [
    {
      "user_id": "usr_9b2c4d...",
      "verification_id": "ver_660e84...",
      "status": "completed",
      "risk": { "level": "low", "reasons": [] },
      "match": {
        "first_name": "match",
        "last_name": "match",
        "date_of_birth": "match",
        "ssn": "match"
      },
      "watchlist": { "status": "clear" }
    }
  ],
  "created_at": "2026-01-15T10:30:00Z"
}
```
```

--------------------------------

### TIN Verification - Pending Response (Service Unavailable)

Source: https://docs.getpalm.com/api-reference/v1/verification/verify-tin

Example response when the IRS TIN Matching service is temporarily unavailable. The request should be retried later.

```json
{
  "verification_id": "1ecaf2a6-b4f6-4810-a45e-b4abe1be19e5",
  "object": "tin_verification",
  "tin_type": "ein",
  "matched": null,
  "status": "pending",
  "unavailable_reason": "tin_matching_service_unavailable",
  "reference_id": "tin_req_12345",
  "created_at": "2026-04-22T05:33:01.665Z"
}
```

--------------------------------

### Subscribe a business to monitoring events

Source: https://docs.getpalm.com/monitor/overview

Use this cURL command to subscribe a specific business to receive monitoring events. Ensure you have your Palm API key and a verified business ID.

```bash
curl -X POST https://api.getpalm.com/v1/business/bus_4c7e1a.../subscription \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sk_test_...'
```

--------------------------------

### Create User

Source: https://docs.getpalm.com/api-reference/v1/user/create-a-new-user

This operation creates a new user record. You can optionally provide a display name, metadata for custom attributes, and vault data for sensitive information using specific key formats like `identity.first_name`.

```APIDOC
## POST /v1/user

### Description
Creates a new user record with optional display name, metadata, and vault data. Vault fields use the `identity.*` key format (e.g., `identity.first_name`, `identity.email`).

### Method
POST

### Endpoint
/v1/user

### Request Body
- **metadata** (object) - Optional - Store up to 50 custom key-value pairs for application-specific data. Useful for storing references to external systems, feature flags, or other custom attributes.
  - **additionalProperties** (string) - Key-value pairs for metadata.
  - **maxProperties**: 50
- **display_name** (string) - Optional - Display name for the user.
- **vault** (object) - Optional - User data to store in the vault. Use vault field IDs as keys (e.g., "identity.email", "identity.first_name").

### Request Example
```json
{
  "metadata": {
    "external_id": "user_789_in_my_system",
    "customer_tier": "standard",
    "signup_source": "web"
  },
  "display_name": "John Doe",
  "vault": {
    "identity.first_name": "John",
    "identity.last_name": "Doe",
    "identity.email": "john.doe@example.com",
    "identity.date_of_birth": "1990-01-15"
  }
}
```

### Response
#### Success Response (201)
- **id** (string) - Unique identifier for the resource.
- **object** (string) - Object type identifier, always "user".
- **created_at** (string) - ISO 8601 timestamp of when the resource was created.
- **updated_at** (string) - ISO 8601 timestamp of when the resource was last updated.
- **metadata** (object) - Custom key-value pairs for application-specific data.
- **status** (string) - Current status of the user (e.g., active, suspended, deleted).
- **verification** (object) - Most recent verification information. Null if user has never been verified.
- **display_name** (string) - Display name for the user.
- **email_fingerprint** (string) - Fingerprint of the user's email.

#### Response Example
```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "user",
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "metadata": {
    "external_id": "user_123_in_my_system",
    "customer_tier": "premium",
    "signup_source": "mobile_app"
  },
  "status": "active",
  "verification": null,
  "display_name": "John Doe",
  "email_fingerprint": "a1b2c3d4e5f67890"
}
```

### Error Handling
- **400**: Bad Request
- **401**: Unauthorized
- **429**: Rate Limited
- **500**: Server Error
```

--------------------------------

### Create User

Source: https://docs.getpalm.com/api-reference/v1/user/create-a-new-user

Creates a new user record with optional display name, metadata, and vault data. Vault fields use the `identity.*` key format (e.g., `identity.first_name`, `identity.email`).

```APIDOC
## Create User

### Description
Creates a new user record with optional display name, metadata, and vault data. Vault fields use the `identity.*` key format (e.g., `identity.first_name`, `identity.email`).

### Method
POST

### Endpoint
/v1/user

### Parameters
#### Request Body
- **displayName** (string) - Optional - The display name for the user.
- **metadata** (object) - Optional - Key-value pairs for additional user metadata.
- **vault** (object) - Optional - Vault data for the user, using `identity.*` keys (e.g., `identity.first_name`, `identity.email`).

### Request Example
```json
{
  "displayName": "John Doe",
  "metadata": {
    "plan": "free"
  },
  "vault": {
    "identity.email": "john.doe@example.com",
    "identity.phone": "123-456-7890"
  }
}
```

### Response
#### Success Response (200)
- **userId** (string) - The unique identifier for the newly created user.
- **createdAt** (string) - The timestamp when the user was created.

#### Response Example
```json
{
  "userId": "usr_12345abcde",
  "createdAt": "2023-10-27T10:00:00Z"
}
```
```

--------------------------------

### Get Specific Business Registration

Source: https://docs.getpalm.com/onboard/registry-search

Retrieve a detailed record for a specific business using its registration jurisdiction and registration number. This endpoint provides more comprehensive information than the search endpoint.

```APIDOC
## GET /v1/business/registry/{registration_jurisdiction}/{registration_number}

### Description
Retrieves a detailed record for a specific business registration using its jurisdiction and registration number. Provides more comprehensive data than the search endpoint.

### Method
GET

### Endpoint
https://api.getpalm.com/v1/business/registry/{registration_jurisdiction}/{registration_number}

### Parameters
#### Path Parameters
- **registration_jurisdiction** (string) - Required - The jurisdiction where the business is registered.
- **registration_number** (string) - Required - The unique registration number assigned to the business by the jurisdiction.

### Response
#### Success Response (200)
- **palm_id** (string) - Unique Palm identifier for the business.
- **name** (string) - The legal name of the business.
- **formation_date** (string) - The date the business was formed.
- **formation_jurisdiction** (string) - The jurisdiction where the business was formed.
- **registration_jurisdiction** (string) - The jurisdiction where the business is registered to operate.
- **status** (string) - The current status of the business.
- **entity_type** (string) - The type of legal entity.
- **registration_number** (string) - The official registration number.
- **principal_address** (object) - The primary physical address of the business.
- **mailing_address** (object) - The mailing address of the business.
- **standing** (object) - Information about the business's standing (e.g., registration, tax, agent compliance).
- **fictitious_names** (array) - List of fictitious names (DBA) the business operates under.
- **industry_codes** (array) - List of industry codes associated with the business.
- **associates** (array) - List of people associated with the business (e.g., agents, members).

#### Response Example
```json
{
  "palm_id": "1234-5678-9012",
  "name": "Acme Corp",
  "formation_date": "2020-03-15",
  "formation_jurisdiction": "US-DE",
  "registration_jurisdiction": "US-CA",
  "status": "active",
  "entity_type": "llc",
  "registration_number": "202012345678",
  "principal_address": {
    "country": "US",
    "street_line_1": "100 Main Street",
    "street_line_2": "Suite 200",
    "city": "San Francisco",
    "region": "CA",
    "postal_code": "94105"
  },
  "mailing_address": {
    "country": "US",
    "street_line_1": "100 Main Street",
    "street_line_2": "Suite 200",
    "city": "San Francisco",
    "region": "CA",
    "postal_code": "94105"
  },
  "standing": {
    "registration": "compliant",
    "tax": "compliant",
    "agent": "compliant"
  },
  "fictitious_names": ["DBA Name LLC"],
  "industry_codes": [
    {
      "code": "541511",
      "type": "naics",
      "description": "Custom Computer Programming Services"
    }
  ],
  "associates": [
    {
      "role": "agent",
      "name": "John Smith",
      "type": "person",
      "title": "Registered Agent",
      "address": {
        "country": "US",
        "street_line_1": "100 Main Street",
        "street_line_2": "Suite 200",
        "city": "San Francisco",
        "region": "CA",
        "postal_code": "94105"
      }
    },
    {
      "role": "member",
      "name": "Jane Doe",
      "type": "person",
      "title": "Managing Member"
    }
  ]
}
```
```

--------------------------------

### Create a new user

Source: https://docs.getpalm.com/llms.txt

Creates a new user record with optional display name, metadata, and vault data. Vault fields utilize the `identity.*` key format for personal information.

```APIDOC
## POST /v1/user/create-a-new-user

### Description
Creates a new user record with optional display name, metadata, and vault data.

### Method
POST

### Endpoint
/v1/user/create-a-new-user

### Parameters
#### Request Body
- **display_name** (string) - Optional - Display name for the user.
- **metadata** (object) - Optional - Key-value pairs for additional user information.
- **vault_data** (object) - Optional - Vault fields using the `identity.*` key format (e.g., `identity.first_name`, `identity.email`).
```

--------------------------------

### Re-verify Existing Business Request

Source: https://docs.getpalm.com/verify/verify-a-business

Send a POST request to the /v1/business/{business_id}/verification endpoint to re-verify an existing business. This retrieves current data from the vault and runs verification against stored values. Include a workflow_key and an optional reference_id.

```Bash
curl -X POST https://api.getpalm.com/v1/business/biz_4c7e1a.../verification \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer sk_test_...' \
  -d '{
    "workflow_key": "business_verification_default",
    "reference_id": "reverify_12345"
  }'
```

--------------------------------

### Device Object

Source: https://docs.getpalm.com/api-reference/v1/verification/verify-business

Contains information about the device used during verification.

```APIDOC
## Device Object

### Description
Contains information about the device used during verification.

### Properties
- **risk_score** (number) - Device-based risk score (0-100). Example: `10`.
- **is_emulator** (boolean) - Whether device is an emulator. Example: `false`.
- **is_vpn** (boolean) - Whether connection is through VPN. Example: `false`.
- **is_proxy** (boolean) - Whether connection is through proxy. Example: `false`.
```

--------------------------------

### Watchlist Match Details in JSON Response

Source: https://docs.getpalm.com/verify/verify-a-person

This JSON structure shows an example of watchlist match details when a potential or confirmed match is found. It includes the status and a list of matches with their type and confidence score.

```json
{
  "watchlist": {
    "status": "potential_match",
    "matches": [
      {
        "type": "pep",
        "name": "tauxbe",
        "confidence_score": 72
      }
    ]
  }
}
```