Skip to main content
POST
Create a doctor account

Autorizações

Authorization
string
header
obrigatório

Chave de API enviada como token Bearer

Corpo

application/json

Request body for creating an institutional doctor account.

email
string
obrigatório
Maximum string length: 254
Exemplo:

"dr.juan@clinica.com"

doctorSpecialties
enum<string>[]
obrigatório

Accepts either the specialty key ('CARDIOLOGY') or value ('cardiology'); always persisted as the value.

Minimum array length: 1
Opções disponíveis:
acupuncture,
alternativeMedicine,
ayurvedicMedicine,
chiropractic,
herbalMedicine,
homeopathy,
naturopathy,
traditionalChineseMedicine,
cosmeticDentistry,
dentistry,
developmentalBehavioralPediatrics,
endodontics,
forensicDentistry,
maxillofacialProsthodontics,
oralMaxillofacialSurgery,
oralMedicine,
oralPathology,
oralSurgery,
orthodontics,
pediatricDentistry,
periodontics,
prosthodontics,
addictionPsychiatry,
adolescentMedicine,
aerospaceMedicine,
allergyImmunology,
andrology,
anesthesiology,
anesthesiologyCriticalCare,
bariatricSurgery,
breastRadiology,
breastSurgery,
cardiacSurgery,
cardiovascularSurgery,
cardiology,
cardiovascularDisease,
cardiovascularRiskProgram,
childAbusePediatrics,
childAdolescentPsychiatry,
childNeurology,
childWelfareSocialWork,
clinicalNeurophysiology,
clinicalSocialWork,
colorectalSurgery,
communityMedicine,
communitySocialWork,
consultationLiaisonPsychiatry,
cosmeticDermatology,
craniofacialTrauma,
dermatology,
dermoscopy,
diabetes,
diagnosticRadiology,
electrophysiology,
emergencyCriticalCare,
emergencyMedicine,
emergencyPsychiatry,
endocrineSurgery,
endocrinology,
epilepsy,
facialPlasticSurgery,
familyMedicine,
familySocialWork,
footAnkleSurgery,
forensicPsychiatry,
forensicSocialWork,
gastroenterology,
generalMedicine,
generalMedicinePsychiatry,
generalSurgery,
geriatricMedicine,
geriatricPsychiatry,
geriatricSocialWork,
ginecology,
gynecologicOncology,
gynecologicSurgery,
gynecology,
handSurgery,
headNeckSurgery,
headacheMedicine,
heartFailureTransplantCardiology,
hematology,
hepatobiliarySurgery,
hipKneeSurgery,
hospitalist,
infectiousDisease,
internalCriticalCare,
internalMedicine,
interventionalCardiology,
interventionalRadiology,
maternalFetalMedicine,
medicalSocialWork,
militarySocialWork,
minimallyInvasiveGynecologicSurgery,
mohsSurgery,
musculoskeletalRadiology,
neonatology,
nephrology,
neurocriticalCare,
neuroimmunology,
neurology,
neuromuscularMedicine,
neuroradiology,
neurorehabilitation,
neurosurgery,
neurotology,
nuclearMedicine,
obstetrics,
obstetricsGynecology,
occupationalMedicine,
occupationalSocialWork,
oculoplasticSurgery,
oncology,
oncologySocialWork,
ophthalmology,
orthopedicHandSurgery,
orthopedicSportsMedicine,
orthopedicTrauma,
orthopedics,
otolaryngology,
painMedicine,
palliativeMedicine,
palliativeSocialWork,
pediatricAllergyImmunology,
pediatricAnesthesiology,
pediatricCardiology,
pediatricCriticalCare,
pediatricDermatology,
pediatricEmergencyMedicine,
pediatricEndocrinology,
pediatricENT,
pediatricGastroenterology,
pediatricHematologyOncology,
pediatricInfectiousDisease,
pediatricNephrology,
pediatricNeurology,
pediatricCardiacSurgery,
pediatricOncology,
pediatricOphthalmology,
pediatricOrthopedics,
pediatricPalliativeCare,
pediatricPulmonology,
pediatricRadiology,
pediatricRheumatology,
pediatricSocialWork,
pediatricSurgery,
pediatricTrauma,
pediatricUrology,
pediatrics,
perinatalPsychiatry,
physicalMedicineRehab,
plasticSurgery,
prenatalCareProgram,
preventiveMedicine,
psychiatricSocialWork,
psychiatry,
psychosomaticMedicine,
publicHealth,
pulmonaryDisease,
pulmonology,
radiationOncologist,
radiationOncology,
reproductiveEndocrinology,
retinaSurgery,
rheumatology,
riasProgram,
manager,
schoolSocialWork,
shoulderElbowSurgery,
sleepMedicine,
socialWork,
spinalCordInjury,
spinalTrauma,
spineSurgery,
sportsMedicine,
substanceAbuseSocialWork,
surgicalOncology,
telemedicine,
thoracicSurgery,
transplantHepatology,
transplantSurgery,
traumaSurgery,
traumatology,
triage,
unknown,
urgentCare,
urologicOncology,
urology,
vascularSurgery,
nursing,
clinicalNutrition,
eatingDisorderNutrition,
gastroenterologicNutrition,
geriatricNutrition,
nutrition,
oncologyNutrition,
pediatricNutrition,
renalNutrition,
sportsNutrition,
clinicalPsychology,
counselingPsychology,
developmentalPsychology,
forensicPsychology,
geropsychology,
healthPsychology,
industrialOrganizationalPsychology,
militaryPsychology,
neuropsychology,
positivePsychology,
psychology,
rehabilitationPsychology,
schoolPsychology,
sportsPsychology,
occupationalTherapy,
physicalTherapy,
respiratoryTherapy,
speechTherapy,
therapy,
other
Exemplo:
country
string | null

Country as ISO 3166-1 alpha-2 (e.g. 'CO', 'BR'). Also accepts alpha-3 ('COL') or the English country name ('COLOMBIA'); all are normalized to the alpha-2 code Telepatia stores. Omit to inherit the institution's country.

Exemplo:

"CO"

language
string | null

Account UI/content language as ISO 639-1 (e.g. 'es', 'pt', 'en'). Omit to inherit the institution's language.

Exemplo:

"es"

timeZone
string | null

IANA time zone (e.g. 'America/Bogota', 'America/Sao_Paulo'). Omit to inherit the institution's time zone.

Exemplo:

"America/Bogota"

nameFull
string | null
Maximum string length: 500
Exemplo:

"Dr. Juan Pérez"

institutionalBranchName
string | null
Maximum string length: 255
Exemplo:

"Sede Norte"

internalCode
string | null

Idempotency key scoped to the institution. Re-submitting the same value returns 409 if the account already exists. Omit to have the server generate a UUID v7 (no idempotency when generated); the value is returned in the response.

Maximum string length: 128
Exemplo:

"DOC-001"

apiKeyConfig
ApiKeyConfig · object | null

Optional API key settings. Omit to mint a key valid for 365 days (1 year).

Resposta

Successful Response

Response body after creating an institutional doctor account.

id
string
obrigatório

Account publicId (acc_*). Use this as the identifier in subsequent API calls.

Exemplo:

"acc_a1b2c3d4e5f6g7h8"

email
string
obrigatório
Exemplo:

"dr.juan@clinica.com"

apiKey
string
obrigatório

Raw secret API key for this account. Shown only once — store it securely.

Exemplo:

"<shown-once-store-securely>"

internalCode
string
obrigatório

Institution-scoped code for this account. Echoes the request value when supplied; otherwise a server-generated UUID v7. Always present — store it to fetch the account later via GET /accounts/{internalCode}.

Exemplo:

"DOC-001"

expiresAt
string | null
obrigatório

UTC timestamp when this API key expires. Always present for institutional keys.

Exemplo:

"2027-06-17T00:00:00Z"

apiKeyExpiresInDays
integer
obrigatório

API key lifetime in days that was applied (the validForDays used, default 365).

Exemplo:

365

publishableApiKey
string | null

Raw publishable (pk_) key for the browser/embed exchange flow. Exchange-only (cannot call the API directly) and shown only once — minted alongside the secret key.

Exemplo:

"<shown-once-store-securely>"