Register a new organization and user

POST /register

When provided appropriate credentials, this route updates an API user's information for registration.

Body Required

Provide valid credentials, this route updates an API User's password.


  • 200 object

    API user successfully registered

    • api_user_id string Required

      The unique ID in Canopy for this API user

    • organization_name string Required

      The organization to which the API user belongs.

    • name_first string Required

      The first name of the API user.

    • name_last string Required

      The last name of the API user.

    • email string(email) Required

      The email address of this API User

    • phone string | null

      Phone number of the API user

    • role integer Required

      The role of this user in the API

  • 401


  • 403


  • 404

    Not found.

  • 429

    Too many requests.

  • Unexpected Error.

POST /register
curl \
 -X POST https://<your_environment_name> \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"name_first":"Harriet","name_last":"Martins","password":"newSecretPassword123!","email":"","organization_name":"Acme Corporation"}'
Request example
  "name_first": "Harriet",
  "name_last": "Martins",
  "password": "newSecretPassword123!",
  "email": "",
  "organization_name": "Acme Corporation"
Response example (200)
  "api_user_id": "dc3d83c5-b31e-48eb-80e7-38f12ac1a6e5",
  "organization_name": "Lever Card 3000",
  "name_first": "Analise",
  "name_last": "Goldberg",
  "email": "",
  "phone": "1-123-456-7890",
  "role": 1