Skip to main content

Get Mobile User Membership Info by Auth Code

Return mobile user membership info, including the redemption code necessary for processing member redemptions.

Request​

GET:/{integrationId}/getrecordbyauthcode/{authcode}

Request Parameters​

ParameterDescriptionTypeRemark
authCodeThe authentication code of the mobile user.stringrequired
  • It can be obtained from the "Show QR" page of the OneRewards app.
  • It can only be used to call api once as it will be invalid after use.

Example of Request URL:

Parameters:
authCode = 8742159632145870
integrationId = d9cdb75e-da7c-43dc-8dee-7d786b464c59

URL:
GET: https://onerewards-integration-api.autocountcloud.com/d9cdb75e-da7c-43dc-8dee-7d786b464c59/getrecordbyauthcode/8742159632145870

Response​

Success Response​

Status Code: 200

Response Body​

Get Mobile User Membership Info by Auth Code View Model
FieldDescriptionTypeRemark
mobileUserIdSystem generated id for mobile user.string
memberIdSystem generated id for member.numbernullableIt will be null if mobile user is not member of the company.
redemptionCodeAuto-generated code used to make member redemption.numbernullable
  • It will be null if mobile user is not member of the company.
  • It will be expired after 10 minutes. It cannot be used for redemptions after it expired.
redemptionCodeExpirationTimeRedemption code expiration time.date
Example of Success Response Body
{
  "mobileUserId": "deb599aa-fe56-4ae1-8c70-4a18315f7f86",
  "memberId": 1,
  "redemptionCode": 1,
  "redemptionCodeExpirationTime": "2023-08-25T12:02:07.850Z"
}

Error Response​