Authentication

Two header-based authentication methods are required:

Header	Type	In	Description
x-api-key	token	header	API key credential
x-client-id	token	header	Client identifier credential

Path Parameters

Parameter	Type	Required	Description
professionalId	string (UUID)	Yes	Unique identifier for the professional.

Example Request — cURL

curl -X GET "https://api.propelus.com/v2/professionals/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a" \
  -H "x-api-key: <your-api-key>" \
  -H "x-client-id: <your-client-id>"

Example Request — JSON

fetch("https://api.propelus.com/v2/professionals/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a", {
  method: "GET",
  headers: {
    "x-api-key": "<your-api-key>",
    "x-client-id": "<your-client-id>"
  }
})

Responses

200 — Success

Returns the professional's full demographic detail.

{
  "id": "628fc8e2-ee7e-4779-9eb7-d980e7a92f3a",
  "externalId": "T-100",
  "dob": "19770428",
  "ssn": "000482915",
  "npi": "1739204857",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "st",
    "zip": "strin"
  },
  "email": "user@example.com",
  "customProperties": {
    "property1": "string",
    "property2": "string"
  },
  "name": {
    "prefix": "Dr.",
    "first": "string",
    "middle": "string",
    "last": "string",
    "suffix": "string",
    "full": "Jane A Smith"
  },
  "alias": {
    "prefix": "Dr.",
    "first": "string",
    "middle": "string",
    "last": "string",
    "suffix": "string",
    "full": "Jane A Smith"
  }
}

Error Responses

Standardized error bodies. Validation-style errors include an errors array; each item contains detail, pointer, parameter, header, and code.

400 — Bad Request

{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}

401 — Unauthorized

{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}

403 — Forbidden

{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}

404 — Not Found

{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}

429 — Rate Limited

{
  "status": 429,
  "detail": "string",
  "code": "f5d62b05-370e-48be-a755-8675ca146431"
}

5XX — Server Error

{
  "status": 500,
  "detail": "string",
  "code": "unexpected_error"
}