Team API

Invite a team member

Create or link a notary, pretagger, or admin to your business.

POST/team_members/invite

Overview

Provision the business relationship and role-specific information. Account creation, team linkage, onboarding, approval, and assignment eligibility are separate milestones. An invite response alone does not mean a notary can take sessions.

Before you start

The API account must have an owning business administrator and the required team capabilities. Generate a bcrypt password hash server-side; never send a plaintext password. Choose a role and supply only the fields appropriate for it.

Select the role
Build the correct role-specific request.
Invite or link
Store the returned user_data.id.
Complete readiness
Follow onboarding and approval before assigning notarizations.

Parameters

Field	Requirement	Description
`email` string · email	Required	Email address of the person to invite or link.
`first_name` string	Required	The member’s first name.
`last_name` string	Required	The member’s last name.
`password` string · bcrypt hash	Required	A valid bcrypt hash. The example contains a non-executable placeholder; generate your own securely.
`business_role` string · enum	Required	Use notary, pretagger, or admin.
`commission_expires_on` string · date	Conditional	Required for notary. Format YYYY-MM-DD, with a non-past date. Omit for admin and pretagger.
`state` string	Conditional	Full state name. Required for notary when forced onboarding is enabled; not allowed for admin/pretagger.
`county` string	Conditional	County matching the state. Required in forced notary onboarding; not allowed for admin/pretagger.
`commission_number` string	Conditional	Notary commission identifier, required in forced onboarding; omit for admin/pretagger.
`vendor_user_id` string	Optional	Your own user reference. Subsequent team-member routes still use the returned user_data.id.
`role_options` object	Optional	Role permissions supported by your account configuration. Use an approved permission profile; do not assume arbitrary keys take effect.

Request example

Use a server-side API key. Replace example IDs and values before using this request in an approved test environment.

curl --request POST \
  --url 'https://app.bluenotary.us/api/integrationsv2/team_members/invite' \
  --header "Authorization: Bearer $BLUENOTARY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "notary@example.com",
  "first_name": "Avery",
  "last_name": "Notary",
  "password": "REPLACE_WITH_VALID_BCRYPT_HASH",
  "business_role": "notary",
  "commission_expires_on": "2031-12-31",
  "vendor_user_id": "staff-204"
}'

Response

201 · Example success Illustrative values in the current response shape.

{
  "success": true,
  "created": true,
  "already_linked": false,
  "user_data": {
    "id": "69a100000000000000000204",
    "email": "notary@example.com",
    "name": "Avery Notary",
    "first_name": "Avery",
    "last_name": "Notary",
    "role": "notary",
    "business_role": "notary",
    "state": "",
    "county": "",
    "commission_number": "",
    "commission_expires_on": "2031-12-31T00:00:00.000Z",
    "onboarding_status": "passworddone",
    "vendor_user_id": "staff-204",
    "created_at": "2030-01-15T14:00:00.000Z",
    "updated_at": "2030-01-15T14:00:00.000Z"
  }
}

Returns 201 for a new user and 200 when an eligible existing user is linked.
The response does not contain an onboarding link. The resend-invite operation can generate one.
The sample onboarding status is illustrative; use the actual returned value. Even complete onboarding does not establish assignment eligibility.
New notaries can remain pending approval. Confirm eligibility before using session_notary_email.

Errors & recovery

Status	What happened	What to do
422	Missing required fields	Supply email, first_name, last_name, password, and business_role.
400	Invalid password format	Generate and supply a valid bcrypt hash rather than plaintext.
400	Invalid or missing notary information	Check commission expiry and the account’s onboarding requirements.
403	Vendor admin not found	Complete the account’s business-administrator setup.
409	Member already linked or account conflict	Inspect the existing relationship before attempting another invite.

Explore the response

Response simulator

LOCAL EXAMPLE

Explore the example response without an API key. This does not send requests or validate your account configuration.

Example request body

Keep building

Need help with your implementation?Visit the help center