Users

Confirm a user (signup confirmation or staged email change apply)

Single endpoint for two flows. If the user is unconfirmed, marks them confirmed (signup confirmation). If the user is confirmed and the token's stored email differs, swaps user.email and revokes all sessions (email change apply). Replays of the same token are rejected as already-expired or already-confirmed.

post/v1/users/{id}/confirm

Request

  • Base URL
    https://identity-api.paymongo.com
  • URL
    https://identity-api.paymongo.com/v1/users/{id}/confirm
  • Auth
    none required

Path parameters

idstring required

User ID the token belongs to

Request body

Example request

{
  "data": {
    "attributes": {
      "token": "ec_token_abc123"
    }
  }
}

Response

OK

has_moreboolean

Example response

{
  "data": {
    "attributes": {
      "action": "signup_confirmed",
      "confirmed": true,
      "email": "juan@example.com",
      "organization_id": "org_123",
      "user_contact_number": "+639171234567",
      "user_first_name": "Juan",
      "user_last_name": "dela Cruz"
    }
  }
}

Changes

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