Register a new organization and user

POST /register

O auth2

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

application/json

Body Required

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

name_first string Required

The first name of the API user.
name_last string Required

The last name of the API user.
password string

The new password of the API user.
email string(email) Required

The email address of the API user
organization_name string Required

The organization name

Responses

200 application/json

API user successfully registered
Hide response attributes Show response attributes object
- 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

Unauthorized.
403

Forbidden.
404

Not found.
429

Too many requests.
default

Unexpected Error.

POST /register

curl \
 --request POST 'https://sandbox-api.canopyservicing.com/register' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name_first":"Harriet","name_last":"Martins","password":"newSecretPassword123!","email":"harriet@acmecorporation.com","organization_name":"Acme Corporation"}'

Request examples

{
  "name_first": "Harriet",
  "name_last": "Martins",
  "password": "newSecretPassword123!",
  "email": "harriet@acmecorporation.com",
  "organization_name": "Acme Corporation"
}

Response examples (200)

{
  "api_user_id": "dc3d83c5-b31e-48eb-80e7-38f12ac1a6e5",
  "organization_name": "Lever Card 3000",
  "name_first": "Analise",
  "name_last": "Goldberg",
  "email": "marissa@globex.com",
  "phone": "1-123-456-7890",
  "role": 1
}