curl

curl -X GET "https://api.services.payward.com/v1/users/AA45N8G4MLDYWAR7" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"

{
  "data": {
    "id": "AA45N8G4MLDYWAR7",
    "external_reference": "partner-customer-12345",
    "type": "individual",
    "status": {
      "state": "ok",
      "required_actions": []
    },
    "created_at": "2025-08-12T14:08:00Z",
    "accounts": [
      {
        "id": "WX6VJUKWKKPBQE36",
        "name": "main"
      },
      {
        "id": "WC9RDEFHPSGLXRVX",
        "name": "secondary"
      }
    ]
  }
}

Users

Get User

Retrieve a previously created user by their user ID.

Returns the user’s core profile — its canonical id, the partner-supplied external_reference, the user type, the current status (including any required actions that are blocking or pending), the created_at timestamp, and the accounts associated with the user.

Common use cases:

Resolve a partner-side reference to its Payward user.
Poll a user’s status while it’s transitioning (for example, after submitting verifications).
Confirm a user exists and retrieve its account IDs before issuing account-scoped calls.

GET

users

{user_id}

curl

curl -X GET "https://api.services.payward.com/v1/users/AA45N8G4MLDYWAR7" \
  -H "API-Key: $PWS_API_KEY" \
  -H "API-Nonce: $PWS_API_NONCE" \
  -H "API-Sign: $PWS_API_SIGN"

{
  "data": {
    "id": "AA45N8G4MLDYWAR7",
    "external_reference": "partner-customer-12345",
    "type": "individual",
    "status": {
      "state": "ok",
      "required_actions": []
    },
    "created_at": "2025-08-12T14:08:00Z",
    "accounts": [
      {
        "id": "WX6VJUKWKKPBQE36",
        "name": "main"
      },
      {
        "id": "WC9RDEFHPSGLXRVX",
        "name": "secondary"
      }
    ]
  }
}

Authorizations

API-Key

string

header

required

Your public API key. Identifies the partner making the request.

API-Nonce

string

header

required

Monotonically increasing nonce included in the request signature.

API-Sign

string

header

required

HMAC signature over the request, computed with your private key.

Path Parameters

user_id

string

required

ID of the user the request applies to. For partners operating in the B2B2C model, this is the Sub-User the request is acting on behalf of. Canonical identifier for a user in the Payward public API.

Required string length: 14 - 42

Response

data

object

required

Show child attributes

Update User

⌘I