Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Compliance

Update an application

Updates properties on an existing application.

Uses JSON Merge Patch semantics (RFC 7396): omitted fields are unchanged, explicit values overwrite, nested objects merge recursively.

Note: Entity relationships cannot be modified via this endpoint. Use POST /entity_relationships/batch to add and DELETE /entity_relationships/{entity_id} to remove.

Idempotency

The Idempotency-Key header is required.

patch/v0/applications/{id}

Path parameters

idstring required

Unique identifier for the application. Prefixed with application_.

Example:application_xyz123

Application ID

Headers

Idempotency-Keystring required

Unique key to ensure idempotent requests

Request body

status'approved' | 'declined' | 'canceled'

Terminal state of the application. Possible values: approved, declined, canceled.

metadataobject

Arbitrary metadata associated with the application

Example request

{
  "details": {
    "product_name": "Growth Business Credit Line",
    "credit": {
      "underwriting_grade": "99",
      "limit": 5000000,
      "max_limit": 10000000
    }
  },
  "documents": [
    {
      "document_id": "document_2N5Hk8xYmQpL9rBvC3jD",
      "version": "v1"
    }
  ]
}

Response

Application updated successfully.

idstring

Unique identifier for the application. Prefixed with application_.

client_application_idstring

Client-provided identifier for the application. Optional: present only for applications created via file upload, and omitted for applications created through the API, which are identified solely by their server-generated ID.

created_atstring date-time

Lead server-generated ISO 8601 timestamp when the application was created.

updated_atstring date-time

Lead server-generated ISO 8601 timestamp when the application was last updated.

status'approved' | 'declined' | 'canceled'

Terminal state of the application. Possible values: approved, declined, canceled.

metadataobject

Arbitrary metadata associated with the application

Example response

{
  "id": "application_xyz123",
  "entities": {
    "account_holder_type": "commercial",
    "account_holders": [
      "entity_xyz123"
    ],
    "authorized_signers": [
      "entity_xyz123"
    ]
  },
  "details": {
    "product_name": "Growth Business Credit Line",
    "credit": {
      "underwriting_grade": "99",
      "limit": 5000000,
      "max_limit": 10000000
    }
  },
  "documents": [
    {
      "document_id": "document_2N5Hk8xYmQpL9rBvC3jD",
      "version": "v1"
    }
  ]
}