Create visit

POST

/visit

Request

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Body

🟢201Access URL

🟠400Invalid input

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/visit' \
--header 'x-api-key: {{api-key}}' \
--header 'x-docus-key: {{docus-key}}' \
--header 'x-auth-secret: {{auth-secret}}' \
--header 'x-team-id: {{team-id}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "visit_id": "v_010_1",
    "patient_id": "patient_010",
    "date": "2022-07-21",
    "pregnant": "false",
    "physician_email": "sometest@docus.ai",
    "test_ids": [
        {
            "partner_test_id": "35",
            "biomarker_group_id": "GRP007"
        }
    ]
}'

Response Example

201 - Example 1

{
    "patient_url": "https://partner_name.docus.ai/access/result/161c3c10-8343-44b6-9024-8db17b951754/27832ac46ba38993ef01202290cdbeae",
    "physician_url": "https://partner_name.docus.ai/access/result/9024-8db17b9517-54161c3c10-8343-44b6/23ef01202290cdbeae7832ac46ba3899"
}

Modified at 2025-10-24 09:37:15

Get patient by ID

Create composite visit