Check Membership Credentials
Member Management
Check Membership Credentials
Validate a member’s password for authentication.
POST
Check Membership Credentials
Validates a member’s password against their stored credentials, enabling password-based login within your loyalty portal. The password must be hashed (bcrypt or MD5 depending on your program configuration) before sending — never transmit plaintext passwords. On success, the response includes the member’s internal
Id and basic profile details. For OTP-based login, use Generate OTP by Relation Reference → Verify OTP by Relation Reference instead.
Responses
200 — Success
200 — Success
| Path | Type | Description |
|---|---|---|
results.IsSucessful | boolean | true |
results.ErrorCode | string | 000 |
results.ReturnObject.Id | integer | Internal member ID |
results.ReturnObject.FullName | string | Member’s full name |
results.ReturnObject.Email | string | Member’s email address |
results.ReturnObject.Status | integer | Account status — 1=Active |
results.ReturnObject.IsAccountActivated | boolean | Whether the account has been activated |
results.ReturnObject.LastLoggedIn | string (date-time) | Previous login timestamp |
results.ReturnObject.LoginAttempt | integer | Number of failed login attempts since last success |
results.ReturnObject.ForceChangePassword | boolean | true if the member must reset their password on next login |
401 — Invalid Credentials
401 — Invalid Credentials
| Path | Type | Description |
|---|---|---|
results.IsSucessful | boolean | false |
results.ErrorCode | string | Error code from the platform |
results.ExceptionMessage | string | Human-readable reason — check this field for details |
Authorizations
JWT obtained from Generate Auth Token. Pass as Authorization: bearer {token}.
Body
application/json
The member's RelationReference
Example:
"jane.doe@example.com"
Your loyalty program ID
Example:
19
Use 4 for customers
Example:
4
Member's password hashed using bcrypt or MD5 as configured for your program.
Example:
"$2b$10$hashed_password_here"
Response
Credentials valid — returns member profile