Member Checkin Code

Item	Value
Description	This API endpoint issues a temporary checkin code to a member which can then be provided back to a client system (POS, kiosk, associate) for member identification.
Method	GET
Endpoint	https://[environment]api[client_id].crowdtwist.com/v2/members/[user_id]/checkin-code?api_key=[api_key] &id_type=[id_type]

Field Name	Sample Value	Required	Format	Description
URL PARAMETERS
user_id	4353459891	Yes	String	Unique ID for the user: – Third Party ID – CrowdTwist ID – Email Address – Mobile Phone Number – Facebook User ID – Twitter User ID – User Name
QUERY PARAMETERS
api_key	QWERTY	Yes	String	API Key client sends for identification and authentication.
id_type	Email	No	String	The type of ID being sent. Options: – Email Address – Facebook User ID – Twitter User ID – CrowdTwist ID – default ID if id_type is not specified Third Party ID – User Name – Mobile Phone Number

Response Body

Field Name	Sample Value	Required	Format	Description
member_id	4353459891	Yes	Integer	Member’s CrowdTwist User Id.
checkin_code	0813	Yes	String	Member assigned checkin_code.
checkin_code_expiration	2024-01-30T21:13:58Z	Yes	Date	Checkin code expiration (based on client configuration).

Error Responses

Field Name	Sample Value	Required	Format	Description
error	internal_error	Yes	String	The identifier of the category of the error. This gives the client the ability to categorize errors and make assumptions based on the identifier of the error.
message	Coupon could not be found	Yes	String	This is a detailed message around the error specifying, as specifically as possible, what the fields are that are missing or where exactly the error is.

Error Response Codes

Example Response Codes

Response Code	Error	Message
404	page_not_found	Unable to find user.
400	invalid	Checkin codes are not enabled for your program.
429	resource_exhausted	All checkin codes have currently been assigned.
500	internal_error	Member checkin codes cannot be fetched at this time. Please try again later.

Sample Request

GET https://[environment]api[client_id].crowdtwist.com/v2/members/[user_id]/checkin_code?api_key=[api_key]&id_type=[id_type]

Sample Response Body

{
	"member_id": 3,
	"checkin_code": "84048",
	"checkin_code_expiration": "2024-08-08T16:59:48.000Z"
}

Sample Error Responses

{
	"error": "page_not_found",
	"message": "Unable to find user."
}

{
	"error": "invalid",
	"message": "Checkin codes are not enabled for your program."
}