Skip to main content
POST
/
v1
/
auth
/
partner
/
users
Provision user
curl --request POST \
  --url https://api.endaoment.org/v1/auth/partner/users \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "partnerUserIdentifier": "c3f8b2e4-9d1a-4f6b-8e2c-7a5d90c41b3f",
  "firstName": "Ada",
  "lastName": "Lovelace",
  "email": "new-user@altruist.com",
  "address": {
    "line1": "123 Main Street",
    "city": "San Francisco",
    "line2": "Suite 100",
    "state": "CA",
    "zip": "94105",
    "country": "USA"
  }
}
'
{
  "id": "0b3e6f2a-9d1a-4f6b-8e2c-7a5d90c41b3f",
  "partnerUserIdentifier": "c3f8b2e4-9d1a-4f6b-8e2c-7a5d90c41b3f",
  "email": "new-user@altruist.com",
  "techPlatformClientId": "altruist",
  "emailVerificationStatus": "PENDING"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
partnerUserIdentifier
string
required

Opaque partner-generated identifier for this user, used as the partner-scoped idempotency key. Must be 16–64 printable ASCII characters; leading/trailing whitespace is trimmed before validation.

Required string length: 16 - 64
Pattern: ^[\x20-\x7E]{16,64}$
Example:

"c3f8b2e4-9d1a-4f6b-8e2c-7a5d90c41b3f"

​
firstName
string
required

First name of the partner-managed user

Maximum string length: 255
Example:

"Ada"

​
lastName
string
required

Last name of the partner-managed user

Maximum string length: 255
Example:

"Lovelace"

​
email
string<email>
required

Email address of the partner-managed user

Example:

"new-user@altruist.com"

​
address
object
required

Physical address of the partner-managed user

Response

An existing partner-managed user was returned and its non-email identity refreshed.

​
id
string<uuid>
required

Endaoment user id. Persist this and use it for all subsequent operations for this user.

Example:

"0b3e6f2a-9d1a-4f6b-8e2c-7a5d90c41b3f"

​
partnerUserIdentifier
string
required

The opaque partner-generated identifier, echoed back from the request.

Example:

"c3f8b2e4-9d1a-4f6b-8e2c-7a5d90c41b3f"

​
email
string<email>
required

The partner-managed user's email address, normalized to lowercase.

Example:

"new-user@altruist.com"

​
techPlatformClientId
string
required

The tech platform client id that owns this user (derived server-side from the API key).

Example:

"altruist"

​
emailVerificationStatus
enum<string>
required

Email verification status. PENDING until the user completes a first-party login.

Available options:
PENDING,
VERIFIED
Example:

"PENDING"