Get legitimation

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

This API endpoint retrieves the legitimation details for a specific user.

Request

  • user (string): The user ID

  • legitimation (string): The legitimation ID

Response

  • id (string): The ID of the legitimation.

  • number (string): The legitimation number.

  • category (object): Details of the legitimation category including ID, name, and required verifications.

    • id (string): The ID of the category.

    • name (string): The name of the category.

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

  • proofs (array): An array of proof objects.

    • id (string): The ID of the proof.

    • type (object): Details of the proof type including ID and name.

      • id (string): The ID of the type.

      • name (string): The name of the type.

    • documentType (string): The type of document.

    • value (string): The value of the proof.

    • status (string): The status of the proof.

    • metadata (object, optional): Additional metadata for the proof including MIME type and file name.

      • mimeType (string): The MIME type of the file.

      • fileName (string): The name of the file.

  • status (string): The status of the legitimation.

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

    • id (string): The ID of the person.

    • firstName (string): The first name of the person.

    • lastName (string): The last name of the person.

    • email (string): The email of the person.

    • spokenLanguage (string): The spoken language of the person.

  • createdOn (string): The date and time when the legitimation was created.

  • event (object, optional): Details of the event associated with the legitimation.

Authentication#auth

This endpoint does not require authentication.

Responses#responses

200OKGet legitimation