claim_service

Download schema

activities

POST

/api/v2/claim_service/activities

activities

activities › Request Body

integration_instance_external_id

string · required

type

string · required

claim_service_id

string

occurred_at

string

ISO 8601 timestamp; an offset is required, a time without one is read as UTC

vendor_event_id

string

description

string

vendor_event_code

string

vendor_reference

string

The handle the dispatch ack returned; used when claim_service_id is not echoed back

vendor_stage

string

activities › Responses

200

success

boolean · required

required

Messages or errors related to the request

object · required

POST/api/v2/claim_service/activities

curl --request POST \
  --url /api/v2/claim_service/activities \
  --header 'Content-Type: application/json' \
  --data '
{
  "claim_service_id": "claim_service_id",
  "integration_instance_external_id": "integration_instance_external_id",
  "occurred_at": "occurred_at",
  "vendor_event_id": "vendor_event_id",
  "description": "description",
  "type": "type",
  "vendor_event_code": "vendor_event_code",
  "vendor_reference": "vendor_reference",
  "vendor_stage": "vendor_stage"
}
'

Example Request Body

{
  "claim_service_id": "claim_service_id",
  "integration_instance_external_id": "integration_instance_external_id",
  "occurred_at": "occurred_at",
  "vendor_event_id": "vendor_event_id",
  "description": "description",
  "type": "type",
  "vendor_event_code": "vendor_event_code",
  "vendor_reference": "vendor_reference",
  "vendor_stage": "vendor_stage"
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {
    "reason": "reason",
    "accepted": true,
    "status": "status",
    "activity_id": "activity_id",
    "flagged": "flagged",
    "vendor_stage": "vendor_stage"
  }
}

json

application/json

decision_results

POST

/api/v2/claim_service/decision_results

decision_results

decision_results › Request Body

vendor_decision_id

string · required

integration_instance_external_id

string · required

claim_service_id

string

closed_at

string

ISO 8601 timestamp; an offset is required, a time without one is read as UTC

decision_note

string

vendor_reference

string

The handle the dispatch ack returned; used when claim_service_id is not echoed back

decision

string

approved, denied, or absent when the ask was withdrawn

decision_results › Responses

200

success

boolean · required

required

Messages or errors related to the request

data

object · required

POST/api/v2/claim_service/decision_results

curl --request POST \
  --url /api/v2/claim_service/decision_results \
  --header 'Content-Type: application/json' \
  --data '
{
  "claim_service_id": "claim_service_id",
  "vendor_decision_id": "vendor_decision_id",
  "closed_at": "closed_at",
  "integration_instance_external_id": "integration_instance_external_id",
  "decision_note": "decision_note",
  "vendor_reference": "vendor_reference",
  "decision": "decision"
}
'

Example Request Body

{
  "claim_service_id": "claim_service_id",
  "vendor_decision_id": "vendor_decision_id",
  "closed_at": "closed_at",
  "integration_instance_external_id": "integration_instance_external_id",
  "decision_note": "decision_note",
  "vendor_reference": "vendor_reference",
  "decision": "decision"
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

json

application/json

decisions

POST

/api/v2/claim_service/decisions

requests is a list: a vendor can raise several asks in one message.

decisions › Request Body

integration_instance_external_id

string · required

object[] · required

Each ask is {vendor_decision_id, question, vendor_decision_code, opened_at}; opened_at is an ISO 8601 timestamp, an offset is required, a time without one is read as UTC

vendor_reference

string

The handle the dispatch ack returned; used when claim_service_id is not echoed back

claim_service_id

string

decisions › Responses

200

success

boolean · required

required

Messages or errors related to the request

object · required

POST/api/v2/claim_service/decisions

curl --request POST \
  --url /api/v2/claim_service/decisions \
  --header 'Content-Type: application/json' \
  --data '
{
  "vendor_reference": "vendor_reference",
  "integration_instance_external_id": "integration_instance_external_id",
  "requests": [
    {}
  ],
  "claim_service_id": "claim_service_id"
}
'

Example Request Body

{
  "vendor_reference": "vendor_reference",
  "integration_instance_external_id": "integration_instance_external_id",
  "requests": [
    {}
  ],
  "claim_service_id": "claim_service_id"
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {
    "status": "status",
    "decision_ids": [
      "string"
    ],
    "accepted": true
  }
}

json

application/json

dispatch_result

POST

/api/v2/claim_service/dispatch_result

dispatch_result

dispatch_result › Request Body

integration_instance_external_id

string · required

claim_service_id

string

error_code

string

accepted

boolean

Default: true

occurred_at

string

ISO 8601 timestamp; an offset is required, a time without one is read as UTC

vendor_event_id

string

description

string

vendor_reference

string

The handle the dispatch ack returned; used when claim_service_id is not echoed back

dispatch_result › Responses

200

success

boolean · required

required

Messages or errors related to the request

data

object · required

POST/api/v2/claim_service/dispatch_result

curl --request POST \
  --url /api/v2/claim_service/dispatch_result \
  --header 'Content-Type: application/json' \
  --data '
{
  "claim_service_id": "claim_service_id",
  "error_code": "error_code",
  "accepted": true,
  "integration_instance_external_id": "integration_instance_external_id",
  "occurred_at": "occurred_at",
  "vendor_event_id": "vendor_event_id",
  "description": "description",
  "vendor_reference": "vendor_reference"
}
'

Example Request Body

{
  "claim_service_id": "claim_service_id",
  "error_code": "error_code",
  "accepted": true,
  "integration_instance_external_id": "integration_instance_external_id",
  "occurred_at": "occurred_at",
  "vendor_event_id": "vendor_event_id",
  "description": "description",
  "vendor_reference": "vendor_reference"
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

json

application/json

documents

POST

/api/v2/claim_service/documents

documents

documents › Request Body

integration_instance_external_id

string · required

mime_type

string

content

string

Document body

claim_service_id

string

occurred_at

string

ISO 8601 timestamp; an offset is required, a time without one is read as UTC

vendor_event_id

string

vendor_event_code

string

vendor_reference

string

The handle the dispatch ack returned; used when claim_service_id is not echoed back

doc_type

string

title

string

documents › Responses

200

success

boolean · required

required

Messages or errors related to the request

object · required

POST/api/v2/claim_service/documents

curl --request POST \
  --url /api/v2/claim_service/documents \
  --header 'Content-Type: application/json' \
  --data '
{
  "mime_type": "mime_type",
  "content": "content",
  "claim_service_id": "claim_service_id",
  "integration_instance_external_id": "integration_instance_external_id",
  "occurred_at": "occurred_at",
  "vendor_event_id": "vendor_event_id",
  "vendor_event_code": "vendor_event_code",
  "vendor_reference": "vendor_reference",
  "doc_type": "doc_type",
  "title": "title"
}
'

Example Request Body

{
  "mime_type": "mime_type",
  "content": "content",
  "claim_service_id": "claim_service_id",
  "integration_instance_external_id": "integration_instance_external_id",
  "occurred_at": "occurred_at",
  "vendor_event_id": "vendor_event_id",
  "vendor_event_code": "vendor_event_code",
  "vendor_reference": "vendor_reference",
  "doc_type": "doc_type",
  "title": "title"
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {
    "reason": "reason",
    "accepted": true,
    "status": "status",
    "activity_id": "activity_id",
    "vendor_stage": "vendor_stage"
  }
}

json

application/json

financials

POST

/api/v2/claim_service/financials

decision ({vendor_decision_id, vendor_decision_code, question}) makes the money a proposal the carrier must approve before it moves.

financials › Request Body

integration_instance_external_id

string · required

amount

required

vendor_financial_id

string · required

claim_service_id

string

vendor_financial_code

string

array

occurred_at

string

ISO 8601 timestamp; an offset is required, a time without one is read as UTC

vendor_reference

string

The handle the dispatch ack returned; used when claim_service_id is not echoed back

decision

object

{vendor_decision_id, vendor_decision_code, question}: makes the money a proposal the carrier must approve

financials › Responses

200

success

boolean · required

required

Messages or errors related to the request

data

object · required

POST/api/v2/claim_service/financials

curl --request POST \
  --url /api/v2/claim_service/financials \
  --header 'Content-Type: application/json' \
  --data '
{
  "claim_service_id": "claim_service_id",
  "vendor_financial_code": "vendor_financial_code",
  "integration_instance_external_id": "integration_instance_external_id",
  "amount": {},
  "line_items": [
    {}
  ],
  "vendor_financial_id": "vendor_financial_id",
  "occurred_at": "occurred_at",
  "vendor_reference": "vendor_reference",
  "decision": {}
}
'

Example Request Body

{
  "claim_service_id": "claim_service_id",
  "vendor_financial_code": "vendor_financial_code",
  "integration_instance_external_id": "integration_instance_external_id",
  "amount": {},
  "line_items": [
    {}
  ],
  "vendor_financial_id": "vendor_financial_id",
  "occurred_at": "occurred_at",
  "vendor_reference": "vendor_reference",
  "decision": {}
}

json

Example Responses

{
  "success": true,
  "messages": [
    "string"
  ],
  "data": {}
}

json

application/json

claim_properties claim_services