Access Control - Entry Authorization

Description

This endpoint is responsible for authorizing or denying a person's entry into an access control device (turnstile, manual device, etc.).

🛂 The permission in EVO that grants access to this endpoint is Access Control - Query.

📨 Request Parameters (Request Body)

Authorization is based on user information (member/prospect/visitor), contract/plan rules, and additional conditions (such as temperature, climate, and entry device).

NOTE. Available for use with branch access key and also with General ADM access key.

Parameter	Type	Required	Description
id	int32	Yes	ID of the user registered in EVO.
personType	int32	Yes	Type of person accessing. Values: `1`: Customer, `2`: Prospect, `3`: Staff Member, `4`: Personal
device	int32	Yes	ID of the device used for access. Values: `1`: Digital, `2`: QR Code, `3`: Facial, `4`: Keyboard
idManualEntry	int32	No	ID of the manual release registered in EVO. Necessary in case of release without authentication.
temperature	Decimal	No	Temperature at the time of access, in Celsius. Used for the Rewards Club.
climateId	int32	No	ID of the climate at the time of access. Used for the Rewards Club. Values: `1`: Sunny, `2`: Cold, `3`: Rain, `4`: Storms, `5`: Snow, `6`: Cloudy, `7`: Windy
idTurnstile	int32	Yes	ID of the turnstile registered in EVO.

📤 Response Structure

The response indicates whether the entry was authorized, as well as providing information about the user, plan, access status, and passage details.

Field	Type	Description
authorized	boolean	Indicates whether access was authorized (`true`) or denied (`false`).
message	string	Standard message returned by the system (e.g., "Access authorized", "Plan expired").
messageCustom	string	Custom message configured by the branch.
entryId	int32	Identifier of the entry record in the system.
photoUrl	string	URL of the user's photo, if available.
totalFitcoins	int32	Points or gamification credits (e.g., accumulated fitcoins).
document	string	User's identifying document (e.g., CPF, RG, passport).
planIdPassage	int32	Identifier of the plan used to validate the passage.
planName	string	Name of the active plan at the time of passage.
name	string	Full name of the identified person.
id	int32	Identifier of the person in the system.
passageDirection	string	Direction of the passage (e.g., "Entry", "Exit").
blockedtype	int32	Code for the reason for blocking, if access was denied. Consult the `blockedType` table below.
frequency	int32	Number of accesses recorded in the configured period.
planExpiration	string(date-time)	Date and time of expiration of the current plan.

Block Types `blockedType`

Code	Description
0	No block
1	No access to this branch
2	Manual block in registration
3	Manual restriction in registration
4	No access via keyboard device
5	Block due to expired CREF
6	Block due to suspended contract
7	Contract does not allow access to the specified turnstile
8	Number of entries configured in the contract has been exhausted
9	Access outside the permitted hours in the contract
10	Access not scheduled as required by the contract
11	User with outstanding debt
12	User without medical exam
13	Medical exam expired
14	User without nutritional exam
15	Nutritional exam expired
16	User without dermatological exam
17	Dermatological exam expired
18	Block due to lack of physical evaluation or evaluation expired
19	Gympass user does not have access to the specified turnstile
20	Gympass: access allowed only in the first hour of check-in
21	Gympass: no check-in found
22	Gympass: age not allowed for the plan
23	Gympass: access outside the permitted hours for the product
24	Gympass: GYM-ID registered in EVO is invalid
25	Gympass: server unavailable
26	User's check-in was canceled
27	User's check-in expired
28	User's check-in already validated previously
29	Invalid check-in for the respective Gympass plan
30	Totalpass: no check-in found
31	Totalpass: access allowed only in the first hour of check-in
32	Totalpass: check-in not available for validation
33	Totalpass: user's check-in expired
34	Totalpass: check-in data not found
35	Totalpass: error validating (server unavailable)
36	No service available for access
37	Release invitation does not grant access to the specified turnstile
38	Pending contract signature
39	Access term not accepted by the user
40	PARQ: user without form completion
41	PARQ: pending upload of certificate
42	Maximum occupancy of the gym reached
43	Block due to double access in the configured time
44	Customer without active plan
45	Totalpass: incomplete configuration data
46	Staff member without access to the branch
47	Inactive staff member
48	Staff member accessing outside working hours
49	Personal with suspended contract
50	Personal's contract does not allow access to the specified turnstile
51	Personal without active contract
52	Prospect with expired visit time
53	Prospect without configured visit time

📝 Request Example (Request Body)

{
  "id": 1025,
  "personType": 1,
  "device": 12,
  "idManualEntry": 0,
  "temperature": 36.5,
  "climateId": 2,
  "idTurnstile": 5
}

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params

application/json-patch+json

Example

{
    "id": 0,
    "personType": 0,
    "device": 0,
    "idManualEntry": 0,
    "temperature": 0,
    "climateId": 0,
    "idTurnstile": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Example

{
    "authorized": true,
    "message": "string",
    "messageCustom": "string",
    "entryId": 0,
    "photoUrl": "string",
    "totalFitcoins": 0,
    "document": "string",
    "planIdPassage": 0,
    "planName": "string",
    "name": "string",
    "id": 0,
    "passageDirection": "string",
    "blockedtype": 0,
    "frequency": 0,
    "planExpiration": "2019-08-24T14:15:22.123Z"
}

🟠400Bad Request

Post access control entry authorize

Access Control - Entry Authorization#

Description#

📨 Request Parameters (Request Body)#

📤 Response Structure#

Block Types blockedType#

📝 Request Example (Request Body)#