Follow the question structure recommended by Dev Bot before submitting your integration questions.
idPhoto) or the person's identifier, which can correspond to a member, prospect, employee, or personal trainer. The returned URL is valid for 1 hour.π§ Notes The API key used must have the Access Control β Query permission. At least one of the following parameters must be provided: idPhoto,idMember,idProspect,idEmployee, oridPersonal.The query respects the scope of the API key. A branch API key can only query people belonging to its own branch. General Admin (multi-location) keys can perform queries without this restriction. The returned URL is temporary and is valid for 1 hour.
| Parameter | Type | Required | Description |
|---|---|---|---|
idPhoto | int32 | Conditional | Facial photo identifier. It can be obtained from the IdRecord of the FacialPhotoRegistered webhook. |
idMember | int32 | Conditional | Identifier of the member whose facial photo will be queried. |
idProspect | int32 | Conditional | Identifier of the prospect whose facial photo will be queried. |
idEmployee | int32 | Conditional | Identifier of the employee whose facial photo will be queried. |
idPersonal | int32 | Conditional | Identifier of the personal trainer whose facial photo will be queried. |
| Field | Type | Description |
|---|---|---|
hasFacialPhoto | boolean | Indicates whether the person has a facial photo registered (true or false). |
url | string | Authenticated URL for accessing the facial photo, valid for 1 hour. Returned as an empty value when hasFacialPhoto is false. |
idMember | int32 | Identifier of the member who owns the photo, when the photo belongs to a member. |
idProspect | int32 | Identifier of the prospect who owns the photo, when the photo belongs to a prospect. |
idEmployee | int32 | Identifier of the employee who owns the photo, when the photo belongs to an employee. |
idPersonal | int32 | Identifier of the personal trainer who owns the photo, when the photo belongs to a personal trainer. |
NOTE. The identification fields make it possible to determine who owns the photo, especially when querying by idPhoto. Only the identifier corresponding to the person's type will be populated. WhenhasFacialPhotoisfalse, the identifiers will be returned asnull.