Get Project Passport

Retrieves the Passport details of a specific document by providing the project identifier (UUID) and specifying the desired view (such as history, blockchain, user_data, verifiable_presentation, or certificate_url). The Passport includes the document's audit trail (signature, approval, and view timestamps), user data, and blockchain hash per document action/event.

HTTP Method and URL

Method: GET

URL:

{{host}}/api/v2/projects/:uuid/passport?user_type=ENTERPRISE_API&view=blockchain

Authentication Requirements

• Requires valid authentication (details not specified; add authentication method here).

Path and Query Parameters

• Path Parameter:

  • :uuid (string, required): The unique identifier of the project.

• Query Parameters:

  • user_type (string, required): Specifies the type of user. Example: ENTERPRISE_API.

  • view (string, required): Specifies the view type. Example: blockchain or history.

Example Request

GET {{host}}/api/v2/projects/123e4567-e89b-12d3-a456-426614174000/passport?user_type=ENTERPRISE_API&view=blockchain

Replace _123e4567-e89b-12d3-a456-426614174000_ with your project UUID.

Error Responses

• 400 Bad Request: Invalid or missing parameters.

• 401 Unauthorized: Authentication failed or missing.

• 404 Not Found: Project not found.

• 500 Internal Server Error: Unexpected server error.

Add more error details as needed.

Usage Notes

• The view parameter controls which section of the Passport is returned (e.g., history, blockchain).

• Ensure that the user_type and view parameters are set correctly for your use case.

• For more details, refer to related requests: GET PASSPORT DOCUMENT, Get Passport Document.

Update example requests and responses as needed to match your API's actual output.