How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

xCures Document API

Patient records retrieved by the xCures platform and/or loaded by platform users.

xCures Document API is one of 11 APIs that xCures publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and a changelog.

This API exposes 7 operations across 4 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version V1.

Requests are made against a single base URL, https://partner.xcures.com.

7 operations 4 paths 8 schemas 1 DELETE3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
V1
Base URL
https://partner.xcures.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

xCures Document API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Document 7

Patient records retrieved by the xCures platform and/or loaded by platform users.

POST
/api/v1/patient-registry/document
Create a Document
PublicDocumentController_create 1 param body → 201400401403429
GET
/api/v1/patient-registry/document
Search Documents
PublicDocumentController_getAll 7 params → 200400401403429
GET
/api/v1/patient-registry/document/{documentId}
Get Document
PublicDocumentController_getById 2 params → 200400401403404429
PUT
/api/v1/patient-registry/document/{documentId}
Update Document
PublicDocumentController_update 2 params body → 200400401403404429
PUT
/api/v1/patient-registry/document/{documentId}/reciprocity
Publish Document
PublicDocumentController_reciprocity 2 params body → 200400401403429
DELETE
/api/v1/patient-registry/document/{documentId}/reciprocity
Unpublish Document
PublicDocumentController_unpublish 2 params → 200400401403429
GET
/api/v1/patient-registry/document/{documentId}/pdf
Get Document PDF URL
PublicDocumentController_getPdfById 2 params → 200400401403404429

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are DocumentSummary (12 properties), DocumentDetail (12 properties), CreateDocumentRequest (6 properties), DocumentPaginationResult (6 properties). Each schema is shown below with its type and property counts.

DocumentSummary
object
12 properties 5 required
DocumentReciprocityDto
object
1 property 1 required
CreateDocumentResponse
object
2 properties 2 required
DocumentPdfUrlDto
object
2 properties 2 required
CreateDocumentRequest
object
6 properties 3 required
DocumentDetail
object
12 properties 6 required
UpdateDocumentRequest
object
3 properties
DocumentPaginationResult
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xcures-document-api-openapi.yml Raw ↑

Other APIs xCures publishes across the network.

xCures Application API
xCures Checklist API
xCures Clinical Concepts API
xCures FHIR API
xCures Project API
xCures Query API
xCures Reciprocity Template API
xCures Subject API
xCures Summary API
xCures O Auth API
Where this information came from

This is an independent, third-party profile of xCures Document API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.