Get provider participant

GET
/providers/{providerID}/participants/{participantID}

Look up one of your participants. The path accepts either key: a value starting with usr_ resolves as the Moov participantID, and any other value resolves as the externalID you assigned. Your externalID acts as an alias for the same participant. Returns 404 when neither key matches a participant within your provider.

Auth: API key or bearer token. Scoped to the calling provider.

Request
cURL
curl -X GET https://api.moov.money/providers/{providerID}/participants/{participantID}
Responses
200 401 403 404
The request completed successfully.
{
  "address": {
    "addressLine1": "123 Main St",
    "addressLine2": "Apt 4B",
    "city": "San Francisco",
    "country": "US",
    "postalCode": "94105",
    "stateOrProvince": "CA"
  },
  "createdOn": "2026-08-31T12:00:00Z",
  "emails": [
    {
      "createdOn": "2026-08-31T12:00:00Z",
      "email": "[email protected]"
    }
  ],
  "familyName": "Smith",
  "givenName": "Jane",
  "limitGroups": [
    {
      "groupID": "grp_01HF5J9ZKQT4RXP8M2VYBN3D",
      "name": "Premium"
    }
  ],
  "moovAccountID": "acc_01HF5J9ZKQT4RXP8M2VYBN3D",
  "participantID": "usr_01HF5J9ZKQT4RXP8M2VYBN3D",
  "phones": [
    {
      "createdOn": "2026-08-31T12:00:00Z",
      "phone": {
        "countryCode": "1",
        "number": "5555550101"
      }
    }
  ],
  "status": "active",
  "updatedOn": "2026-08-31T12:00:00Z"
}
Authentication missing, invalid, or insufficient.
Authentication present but the action is forbidden for this principal/claim.
The requested resource was not found.

Headers

X-Moov-Version

string
Set this header to the API version being targeted (e.g. v2026.07.00). When omitted, the server applies its default version.

Path parameters

providerID

string required
Moov account ID.

participantID

string required
The participant’s participantID, or your externalID for them. Both resolve to the same participant.

Response

A participant record: your customer who sends money with Moov Money. A participant is scoped to one provider. The same person can be a participant of more than one provider; each provider keeps its own externalID and record.

givenName

string required
Participant’s given (first) name.

middleName

string
Participant’s middle name or middle initial.

familyName

string required
Participant’s family (last) name.

nickName

string
Name the participant goes by, for example Bob for Robert.

dateOfBirth

string<date>
Participant’s date of birth, YYYY-MM-DD. Omitted when not provided at creation.

address

object
Participant’s primary postal address. Omitted when none was provided at creation.
Show child attributes

address

addressLine2

string
Second line of the street address (apartment, suite, etc.).

city

string required
City / locality.

stateOrProvince

string required
State, province, or region.

postalCode

string required
Postal / ZIP code.

country

string required
ISO 3166-1 alpha-2 country code.

addressLine1

string required
First line of the street address.

moovAccountID

string
Moov account ID linked to this participant. Set for sending participants once they have a linked Moov account; omitted until then.

status

string<enum> required
Current lifecycle status of the participant.
Possible values: active, disabled, pending, denied

phones

array<object> required
Show child attributes

phones[]

createdOn

string<date-time>
When this phone number was added.

disabledOn

string<date-time>
When this phone number was disabled.

phone

object
Phone on this record.
Show child attributes

phones[].phone

number

string required
National significant number without the country calling code. ASCII digits only.

countryCode

string required
ITU country calling code without a leading plus. ASCII digits only.

verifiedOn

string<date-time>
When the participant confirmed ownership of this phone number.

emails

array<object> required
Show child attributes

emails[]

createdOn

string<date-time>
When this email was added.

disabledOn

string<date-time>
When this email was disabled.

email

string
Email address.

verifiedOn

string<date-time>
When the participant confirmed ownership of this email.

limitGroups

array<object>
Limit groups this participant belongs to. Empty when the participant belongs to no group.
Show child attributes

limitGroups[]

groupID

string
Identifier of the limit group.

name

string
Display name of the limit group.

createdOn

string<date-time> required
When this participant was created.

updatedOn

string<date-time> required
When this participant was last updated.

disabledOn

string<date-time>
When this participant was disabled. Omitted while active.

participantID

string required
Unique identifier for this participant.