Internal

Seed an owner user into an existing organization (internal)

Upserts a user attached to organization_id. If a non-deleted user already exists for the org, identity columns are overwritten; otherwise a new owner user is created with a randomly-generated password.

post/v1/users/setup

Request

  • Base URL
    https://identity-api.paymongo.com
  • URL
    https://identity-api.paymongo.com/v1/users/setup
  • Auth
    API key in header X-Internal-Api-Key

Request body

accepted_termsboolean
contact_numberstring
emailstring required
enforce_unique_contact_numberboolean

EnforceUniqueContactNumber opts into rejecting a contact_number already used by a different organization (409), mirroring the cross-org mobile- number rule gateway-api enforces for consumer accounts. Optional, defaults to false so existing callers are unaffected.

first_namestring required
last_namestring required
organization_idstring required

Example request

{
  "accepted_terms": true,
  "contact_number": "+639171234567",
  "email": "merchant@example.com",
  "enforce_unique_contact_number": true,
  "first_name": "Juan",
  "last_name": "dela Cruz",
  "organization_id": "org_abc123"
}

Response

OK

has_moreboolean

Example response

{
  "data": {
    "created": true,
    "email": "merchant@example.com",
    "organization_id": "org_abc123",
    "user_id": "42"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.