Record medical insurance or private pay for a patient

Operations in Coverage

POST /api/v1/coverages

Practor sets the insurer from the plan.

The integration client needs PATIENT_COVERAGE:CREATE. A practice owner grants it under Permissions on the client.

Request

curl Node.js Python

curl -X POST 'https://dashboard.practor.app/api/v1/coverages' \
  -H "Authorization: Bearer $PRACTOR_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "patientId": "k3v9x2m8q1w7e4r6t0y5u2ia",
  "type": "insurance",
  "memberNumber": "900123456",
  "dependentCode": "01",
  "relationship": "self",
  "planId": "n6m1b5v8c2x4z7a9s3d0f5gh"
}'

const response = await fetch("https://dashboard.practor.app/api/v1/coverages", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PRACTOR_API_KEY}`,
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "patientId": "k3v9x2m8q1w7e4r6t0y5u2ia",
    "type": "insurance",
    "memberNumber": "900123456",
    "dependentCode": "01",
    "relationship": "self",
    "planId": "n6m1b5v8c2x4z7a9s3d0f5gh"
  }),
});
const resource = await response.json();

import os, uuid
import requests

response = requests.post(
    "https://dashboard.practor.app/api/v1/coverages",
    headers={
        "Authorization": f"Bearer {os.environ['PRACTOR_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
        "Content-Type": "application/json",
    },
    data="""{
  "patientId": "k3v9x2m8q1w7e4r6t0y5u2ia",
  "type": "insurance",
  "memberNumber": "900123456",
  "dependentCode": "01",
  "relationship": "self",
  "planId": "n6m1b5v8c2x4z7a9s3d0f5gh"
}""",
)
resource = response.json()

Response 201

{
  "object": "coverage",
  "id": "c9d1f4g7h2j5k8l0z3x6v1bn",
  "patientId": "k3v9x2m8q1w7e4r6t0y5u2ia",
  "type": "insurance",
  "status": "active",
  "relationship": "self",
  "memberNumber": "900123456",
  "dependentCode": "01",
  "insurerId": "o1r5g9a3n7i2z6a0t4i8o3np",
  "insurerName": "Example Medical Scheme",
  "planId": "n6m1b5v8c2x4z7a9s3d0f5gh",
  "planName": "Classic",
  "planOptionCode": "600830",
  "priority": 1,
  "paymentMethod": null,
  "verificationStatus": "eligible",
  "verifiedAt": "2026-10-01T07:40:02.000Z",
  "verificationMessage": "Member active",
  "updatedAt": "2026-10-01T07:45:12.000Z"
}

Parameters

Headers

Idempotency-Key string Required

A value you make up, new for each record you create, such as a UUID. If a create times out and you send it again with the same key and body, Practor doesn't create a second record: it answers with the one the first request made, and adds the header Idempotent-Replayed: true so you can tell the answer is a repeat. Keys are remembered for 24 hours.

At most 255 characters.

Request body

Required. Send it as application/json, as a CoverageRequest.

patientId string Required
type string Required
One of insurance, self_pay.
status string
One of active, cancelled, draft, entered_in_error.

Defaults to "active".
relationship string or null
How the patient is related to the main member.
memberNumber string or null
dependentCode string or null
The dependant code on the membership, such as 01.
insurerId string or null
Leave it out and Practor sets it from the plan.
planId string or null
planOptionCode string or null
The plan by its option code, instead of planId.
priority integer or null
Which coverage is claimed from first, 1 first.
paymentMethod string or null
How a private-pay patient pays.

Example body

{
  "patientId": "k3v9x2m8q1w7e4r6t0y5u2ia",
  "type": "insurance",
  "memberNumber": "900123456",
  "dependentCode": "01",
  "relationship": "self",
  "planId": "n6m1b5v8c2x4z7a9s3d0f5gh"
}

Responses

201 Created. The body is what was created; its address is in the Location header. A patient's medical insurance, or their private-pay arrangement.

Headers

X-Request-Id string Required: Quote it if you contact support about this request.
X-RateLimit-Limit string Required: Requests allowed in the current window.
X-RateLimit-Remaining string Required: Requests left in the current window.
X-RateLimit-Reset string Required: When the window resets, in seconds since the Unix epoch.
Location string Required: Where to read what was created.

Body

Coverage

object "coverage" Required
id string Required
patientId string or null Required
type string Required
One of insurance, self_pay.
status string Required
One of active, cancelled, draft, entered_in_error.
relationship string or null Required
memberNumber string or null Required
dependentCode string or null Required
insurerId string or null Required
insurerName string or null Required
planId string or null Required
planName string or null Required
planOptionCode string or null Required
priority integer or null Required
Which coverage is claimed from first.
paymentMethod string or null Required
verificationStatus string or null Required
Whether the membership was confirmed with the insurer: pending while the check runs, eligible or not_eligible as the insurer answered, error when the insurer did not answer and the check should be run again. Null for private pay.
verifiedAt string or null Required
When the insurer was last asked. Null if it never has been.
verificationMessage string or null Required
The insurer's answer in words, or why the check could not be made.
updatedAt string Required
An ISO 8601 date-time in UTC.

Example 201 body

{
  "object": "coverage",
  "id": "c9d1f4g7h2j5k8l0z3x6v1bn",
  "patientId": "k3v9x2m8q1w7e4r6t0y5u2ia",
  "type": "insurance",
  "status": "active",
  "relationship": "self",
  "memberNumber": "900123456",
  "dependentCode": "01",
  "insurerId": "o1r5g9a3n7i2z6a0t4i8o3np",
  "insurerName": "Example Medical Scheme",
  "planId": "n6m1b5v8c2x4z7a9s3d0f5gh",
  "planName": "Classic",
  "planOptionCode": "600830",
  "priority": 1,
  "paymentMethod": null,
  "verificationStatus": "eligible",
  "verifiedAt": "2026-10-01T07:40:02.000Z",
  "verificationMessage": "Member active",
  "updatedAt": "2026-10-01T07:45:12.000Z"
}

400 A query parameter or header is missing or malformed, or the body isn't JSON. errors names the parameter.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 400 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

401 No key was sent, or the key cannot be used: unknown, revoked or expired, its client suspended, or the call made from outside its allowed addresses. All of these answer the same way; the practice audit log names which it was.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 401 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

403 The client lacks the permission this endpoint needs, or the practice's Integrations add-on is off.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 403 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

405 This endpoint doesn't take that method. The Allow header names the one it does.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 405 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

409 The record conflicts with one that exists (detail names it), or a request with the same Idempotency-Key is still running. Wait a moment and retry.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 409 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

413 The body is larger than 256 KB.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 413 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

415 The body wasn't sent as application/json. Set the Content-Type header.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 415 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

422 The body is valid JSON but breaks a rule, or the Idempotency-Key was used with a different body. errors lists every field that is missing or wrong, all at once.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 422 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

429 Too many requests. Wait the number of seconds in the Retry-After header, then send it again.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 429 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

500 Something went wrong on our side. Quote the X-Request-Id if you contact support.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 500 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}

503 The request couldn't be written to the practice audit log, so its result is withheld. Wait the number of seconds in the Retry-After header, then send it again.

Body

Problem

type string Required
Where the error is explained: https://developers.practor.app/guides/errors# and the code, with hyphens for underscores.
title string Required
A short summary of the kind of problem.
status integer Required
The HTTP status, repeated.

At least -9007199254740991. At most 9007199254740991.
detail string Required
What went wrong with this request, in a sentence you can show a person.
code string Required
The kind of problem. It stays the same across releases, so branch on it.

One of invalid_request, invalid_cursor, validation_failed, unauthenticated, forbidden, addon_inactive, not_found, method_not_allowed, conflict, duplicate, business_rule, unprocessable, idempotency_key_reused, payload_too_large, unsupported_media_type, rate_limited, internal_error, service_unavailable.
requestId string Required
The same as the X-Request-Id header. Quote it if you contact support.
errors array of FieldError
One entry per field that is missing or wrong, all at once, so you can fix a request in one round trip.
- field string Required
  The field, query parameter or header the problem is in. A field in the body is a dotted path, such as givenNames.0 or procedures.1.code.
- code string Required
  required when it was left out, invalid when its value is wrong.
  
  One of required, invalid.
- message string Required
  What was wrong, in a sentence you can show a person.

Example 503 body

{
  "type": "https://developers.practor.app/guides/errors#validation-failed",
  "title": "Some fields are missing or wrong",
  "status": 422,
  "detail": "Fix the fields listed in errors and send it again.",
  "code": "validation_failed",
  "requestId": "x9k2m4p7q1w8e3r6t5y0u2i4",
  "errors": [
    {
      "field": "lastName",
      "code": "required",
      "message": "Send lastName."
    },
    {
      "field": "birthDate",
      "code": "invalid",
      "message": "birthDate must be a real date, written YYYY-MM-DD"
    }
  ]
}