Get legitimations

GET{{API_BASE_URL}}/shop/v1/user/:user/legitimations

This endpoint retrieves the legitimations associated with a specific user's account.

Request

  • user (path parameter) - The user ID for which the legitimations are being retrieved.

Response

  • data (array): An array containing the legitimations associated with the user.

    • id: The ID of the legitimations.

    • number: The number associated with the legitimations.

    • category (object): The category details of the legitimations.

      • id: The ID of the category.

      • name: The name of the category.

      • requiredVerifications: The number of required verifications for the category.

    • proofs (array): An array containing proofs related to the legitimations.

      • id: The ID of the proof.

      • type (object): The type details of the proof.

        • id: The ID of the type.

        • name: The name of the type.

      • documentType: The type of document.

      • value: The value of the proof.

      • status: The status of the proof.

    • status: The status of the legitimations.

    • person (object): Details of the person associated with the legitimations.

      • id: The ID of the person.

      • firstName: The first name of the person.

      • lastName: The last name of the person.

      • email: The email of the person.

      • spokenLanguage: The spoken language of the person.

    • createdOn: The date and time when the legitimations were created.

    • event (object): Details of the event associated with the legitimations.

      • id: The ID of the event.

      • name: The name of the event.

      • year: The year of the event.

      • icon (object): Details of the icon associated with the event.

        • key: The key of the icon.

        • uri: The URI of the icon.

        • type: The type of the icon.

        • background: The background of the icon.

      • logo (object): Details of the logo associated with the event.

        • key: The key of the logo.

        • uri: The URI of the logo.

        • type: The type of the logo.

        • background: The background of the logo.

      • isActive: Indicates if the event is active.

      • slug: The slug of the event.

      • dateTimeSpan (object): Details of the date and time span of the event.

        • start: The start date and time of the event.

        • end: The end date and time of the event.

The response may also include an empty array if no legitimations are found for the specified user.

Authentication#auth

This endpoint does not require authentication.

Query parameters#query

event{{EVENT}}optional

The event slug (optional)

Responses#responses

200OKGet legitimations