Creates a user on a practice
curl --request POST \
--url https://api.staging.scan.com/api/v2/practices/{practice_id}/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user": {
"full_name": "<string>",
"email": "[email protected]",
"phone_number": "<string>",
"npi": "<string>",
"role_attributes": {
"role_type": "provider"
}
}
}
'require 'uri'
require 'net/http'
url = URI("https://api.staging.scan.com/api/v2/practices/{practice_id}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user\": {\n \"full_name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone_number\": \"<string>\",\n \"npi\": \"<string>\",\n \"role_attributes\": {\n \"role_type\": \"provider\"\n }\n }\n}"
response = http.request(request)
puts response.read_bodyimport requests
url = "https://api.staging.scan.com/api/v2/practices/{practice_id}/users"
payload = { "user": {
"full_name": "<string>",
"email": "[email protected]",
"phone_number": "<string>",
"npi": "<string>",
"role_attributes": { "role_type": "provider" }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user: {
full_name: '<string>',
email: '[email protected]',
phone_number: '<string>',
npi: '<string>',
role_attributes: {role_type: 'provider'}
}
})
};
fetch('https://api.staging.scan.com/api/v2/practices/{practice_id}/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.staging.scan.com/api/v2/practices/{practice_id}/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user' => [
'full_name' => '<string>',
'email' => '[email protected]',
'phone_number' => '<string>',
'npi' => '<string>',
'role_attributes' => [
'role_type' => 'provider'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.staging.scan.com/api/v2/practices/{practice_id}/users"
payload := strings.NewReader("{\n \"user\": {\n \"full_name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone_number\": \"<string>\",\n \"npi\": \"<string>\",\n \"role_attributes\": {\n \"role_type\": \"provider\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"user": {
"id": "11111111-1111-1111-1111-111111111111",
"full_name": "Grace Hopper",
"email": "[email protected]",
"phone_number": "4045550100",
"npi": "1234567890"
}
}Practices
Creates a user on a practice
Creates a user associated with the given practice. When role_attributes is omitted,
the role defaults to provider.
POST
/
api
/
v2
/
practices
/
{practice_id}
/
users
Creates a user on a practice
curl --request POST \
--url https://api.staging.scan.com/api/v2/practices/{practice_id}/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user": {
"full_name": "<string>",
"email": "[email protected]",
"phone_number": "<string>",
"npi": "<string>",
"role_attributes": {
"role_type": "provider"
}
}
}
'require 'uri'
require 'net/http'
url = URI("https://api.staging.scan.com/api/v2/practices/{practice_id}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"user\": {\n \"full_name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone_number\": \"<string>\",\n \"npi\": \"<string>\",\n \"role_attributes\": {\n \"role_type\": \"provider\"\n }\n }\n}"
response = http.request(request)
puts response.read_bodyimport requests
url = "https://api.staging.scan.com/api/v2/practices/{practice_id}/users"
payload = { "user": {
"full_name": "<string>",
"email": "[email protected]",
"phone_number": "<string>",
"npi": "<string>",
"role_attributes": { "role_type": "provider" }
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
user: {
full_name: '<string>',
email: '[email protected]',
phone_number: '<string>',
npi: '<string>',
role_attributes: {role_type: 'provider'}
}
})
};
fetch('https://api.staging.scan.com/api/v2/practices/{practice_id}/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.staging.scan.com/api/v2/practices/{practice_id}/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'user' => [
'full_name' => '<string>',
'email' => '[email protected]',
'phone_number' => '<string>',
'npi' => '<string>',
'role_attributes' => [
'role_type' => 'provider'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.staging.scan.com/api/v2/practices/{practice_id}/users"
payload := strings.NewReader("{\n \"user\": {\n \"full_name\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone_number\": \"<string>\",\n \"npi\": \"<string>\",\n \"role_attributes\": {\n \"role_type\": \"provider\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"user": {
"id": "11111111-1111-1111-1111-111111111111",
"full_name": "Grace Hopper",
"email": "[email protected]",
"phone_number": "4045550100",
"npi": "1234567890"
}
}Authorizations
Authorization: Bearer <api_token>. Sandbox tokens come from Get API keys
and allow 2,000 successful requests or 7 days. Failed 4xx/5xx responses do
not consume the allowance. Production tokens are issued from the group's
API access tab.
Path Parameters
Practice ID
Body
application/json
Show child attributes
Show child attributes
Response
user created
Show child attributes
Show child attributes

