List schemas

curl --request POST \
  --url https://api.platform.arb.inc/schemas/list \
  --header 'Authorization: Bearer <token>'

{
  "parties": [
    {
      "id": "caseManager",
      "displayName": "Case Manager",
      "description": "Responsible for handling the administrative aspects of the case."
    }
  ],
  "phases": [
    {
      "id": "caseInitiation",
      "displayName": "Case Initiation",
      "description": "The initial phase of the case."
    }
  ],
  "documents": [
    {
      "id": "statementOfClaim",
      "displayName": "Statement of Claim",
      "description": "A formal statement outlining the details of the claim.",
      "sections": [
        {
          "displayName": "Claim Details",
          "description": "This section captures the details of the claim.",
          "sortOrder": 1,
          "fields": [
            {
              "id": "claimDetails",
              "displayName": "Claim Details",
              "required": true,
              "minLength": 10,
              "maxLength": 500,
              "sortOrder": 1,
              "type": "text"
            }
          ]
        }
      ]
    }
  ],
  "evidence": [
    {
      "id": "audio",
      "displayName": "Audio",
      "contentTypes": [
        "audio/mpeg",
        "audio/wav",
        "audio/flac",
        "audio/mp4",
        "audio/ogg"
      ]
    }
  ]
}

POST

schemas

list

List schemas

curl --request POST \
  --url https://api.platform.arb.inc/schemas/list \
  --header 'Authorization: Bearer <token>'

{
  "parties": [
    {
      "id": "caseManager",
      "displayName": "Case Manager",
      "description": "Responsible for handling the administrative aspects of the case."
    }
  ],
  "phases": [
    {
      "id": "caseInitiation",
      "displayName": "Case Initiation",
      "description": "The initial phase of the case."
    }
  ],
  "documents": [
    {
      "id": "statementOfClaim",
      "displayName": "Statement of Claim",
      "description": "A formal statement outlining the details of the claim.",
      "sections": [
        {
          "displayName": "Claim Details",
          "description": "This section captures the details of the claim.",
          "sortOrder": 1,
          "fields": [
            {
              "id": "claimDetails",
              "displayName": "Claim Details",
              "required": true,
              "minLength": 10,
              "maxLength": 500,
              "sortOrder": 1,
              "type": "text"
            }
          ]
        }
      ]
    }
  ],
  "evidence": [
    {
      "id": "audio",
      "displayName": "Audio",
      "contentTypes": [
        "audio/mpeg",
        "audio/wav",
        "audio/flac",
        "audio/mp4",
        "audio/ogg"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

access token

Response

200 - application/json

Schemas successfully retrieved.

parties

object[]

All available parties.

Show child attributes

parties.id

string

Unique party identifier.

Example:

"caseManager"

parties.displayName

string

Human-readable party name.

Example:

"Case Manager"

parties.description

string

Brief explanation of the party.

Example:

"Responsible for handling the administrative aspects of the case."

phases

object[]

All available case phases.

Show child attributes

phases.id

string

Unique phase identifier.

Example:

"caseInitiation"

phases.displayName

string

Human-readable phase name.

Example:

"Case Initiation"

phases.description

string

Brief explanation of the phase.

Example:

"The initial phase of the case."

documents

object[]

All available document schemas.

Show child attributes

documents.id

string

Unique document identifier.

Example:

"statementOfClaim"

documents.displayName

string

Human-readable document name.

Example:

"Statement of Claim"

documents.description

string

Brief explanation of the document.

Example:

"A formal statement outlining the details of the claim."

documents.sections

object[]

Sections belonging to this document.

Show child attributes

documents.sections.displayName

string

Human-readable section name.

Example:

"Claim Details"

documents.sections.description

string

Brief explanation of the section.

Example:

"This section captures the details of the claim."

documents.sections.sortOrder

integer

Numeric order of this section within its parent document.

Example:

1

documents.sections.fields

object[]

Fillable fields in the section.

Show child attributes

documents.sections.fields.id

string

Unique field identifier.

Example:

"claimDetails"

documents.sections.fields.displayName

string

Human-readable field name.

Example:

"Claim Details"

documents.sections.fields.required

boolean

Whether this field is mandatory.

Example:

true

documents.sections.fields.minLength

integer

Minimum required content length.

Example:

10

documents.sections.fields.maxLength

integer

Maximum allowed content length.

Example:

500

documents.sections.fields.sortOrder

integer

Numeric order of this field within its parent section.

Example:

1

documents.sections.fields.type

enum<string>

The data type for this field. Used by the platform to validate input. For example, "boolean" only accepts "true", "false" or blank; "email" enforces email format; "integer" disallows decimals.

Available options:

address,

boolean,

city,

currency,

date,

decimal,

email,

integer,

month,

phone,

state,

text,

time,

url,

year,

zipcode

Example:

"text"

evidence

object[]

All supported evidence types and their allowed MIME content types.

Show child attributes

evidence.id

string

Unique evidence type identifier.

Example:

"audio"

evidence.displayName

string

Human-readable evidence type name.

Example:

"Audio"

evidence.contentTypes

string[]

Allowed MIME content types for this evidence type.

Example:

[
  "audio/mpeg",
  "audio/wav",
  "audio/flac",
  "audio/mp4",
  "audio/ogg"
]

Add a participant to a case Create a service-of-notice mailing

⌘I

Documentation

SDKs

MCP

API

List schemas

Authorizations

Response