Skip to main content
GET
/
user
/
profile
/
{phoneOrEmail}
Get user profile
curl --request GET \
  --url https://raas-partner-cv.nomas.cash/v1/user/profile/{phoneOrEmail} \
  --header 'api_key: <api-key>'
{
  "id": "OSZwErXgt1MGPHwkYJVqz3LTN0R2",
  "email": "maria.arenas@example.com",
  "firstName": "Maria del Carmen",
  "lastName": "Arenas Mendoza",
  "middleName": "Elena",
  "secondLastName": "Ruiz",
  "address1": "Cancún International Airport, Carretera a Aeropuerto Cancún, Cancún, Quintana Roo, Mexico",
  "city": "Cancún",
  "state": "Q.R.",
  "zipCode": "77500",
  "gender": "Female",
  "dob": "1987-06-24T07:00:00.000Z",
  "status": "Approved",
  "phoneNumber": "+5215521206703",
  "countryCode": "MX",
  "createdAt": "2024-01-15T18:30:00.000Z",
  "latitude": 21.0365,
  "longitude": -86.8515
}

Authorizations

api_key
string
header
required

Path Parameters

phoneOrEmail
string
required
  • User identifier (phone with country code or email). Example: +19166020018 or test@example.com.

Response

200 — OK. Profile returned for a registered user.

Scenarios for this response (keep in sync with testing-sandbox.mdx):

ScenarioHow to reproduceTypical body
Known userPath phoneOrEmail is a registered phone (E.164 with +) or email for the tenant; user has subscriber and CIP records.UserProfile with id, names, contact, address, CIP status, createdAt, optional latitude / longitude.

See also Full scenario matrix.

id
string
required
email
string
firstName
string
lastName
string
middleName
string
secondLastName
string
phoneNumber
string
countryCode
string
createdAt
string<date-time>

Subscriber registration timestamp.