Skip to content

Overview

This guide explains the process to create a new customer within Ascend using the Public API. It clarifies which setup steps require internal support and which steps developers can perform themselves.

This is the recommended first API call after obtaining Sandbox credentials.

Prerequisites

RequirementPerformed ByDescription
Organization / tenant provisioningHS1 SupportPartners cannot create organizations directly.
Client credentials (Client ID + Secret) & Scopes provisionedHS1 SupportUsed to retrieve a Sandbox access token.
Executing API callsDeveloperOnce you have Sandbox credentials, customer creation is self-serve.

Environment Note: Sandbox only for initial onboarding.

Authentication

All API requests must use a valid Bearer token retrieved using your Sandbox Client ID, Client Secret, and Organization ID.

(See the Sandbox Access + API Credentials document for how to retrieve access tokens)

Create Customer

POST /v1/customers

Example Request Body

{
  "firstName": "John",
  "lastName": "Example",
  "dateOfBirth": "1990-05-05",
  "gender": "Male",
  "primaryPhone": "5553334444"
}

Expected Response

{
  "id": "customerIdReturnedHere",
  "organizationid": "yourAssignedOrgId",
  "createdDateTime": "2025-01-02T14:15:33Z"
}

Next Steps

After a customer record is created, the next recommended workflow is to create a patient record associated to this customer. Additional onboarding flows (insurance, appointments, etc.) vary by integration use case and can follow after.