For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Partner

Retrieves information about the current partner associated with the provided API key. This endpoint returns essential partner details including unique identifier, name, and current status. Useful for

Endpoint

GET/v2/auth/partner

Link

Request

Authentication

An API key is required for authentication. Include it in the Authorization header.

  • Header: Authorization

  • Value: Your API key token

HTTP Method & URL

  • Method: GET

  • URL: https://stagep.tst-apidmndelss.com/v2/auth/partner

Headers

Key
Value
Required

Authorization

Bearer <JWT>

Yes

Accept

application/json

Yes


Response (200 OK)

Returns the partner object associated with the authenticated API key.

Response Fields

Partner Object (item)

Field
Type
Description
Example

puid

string

Unique partner identifier.

partner_abc123def

name

string

Partner organization name.

Acme Corporation

status

string

Current partner status.

ACCEPT

Status Values

  • NEW - Newly registered partner

  • READY_FOR_MODERATION - Ready for administrative review

  • MODERATED - Under moderation process

  • VERIFY - Verification in progress

  • ACCEPT - Approved and active partner

  • REJECT - Rejected partner application

  • BANNED - Banned/disabled partner

Example Response:


Examples

Basic Partner Retrieval (cURL)


Error Responses

  1. Unauthorized:

  2. Invalid API Key:

  3. Partner Not Found:


Notes

Authentication Context

  • The endpoint automatically determines which partner to return based on the API key

  • Each API key is associated with a specific partner account

  • Useful for verifying authentication and partner status

Status Implications

  • ACCEPT: Partner can make API calls and access services

  • NEW/MODERATED/VERIFY: Partner may have limited API access during onboarding

  • REJECT/BANNED: Partner cannot make API calls or access services

Best Practices

  • Check partner status before performing critical operations

  • Cache partner information to reduce API calls

  • Handle different statuses appropriately in your application

  • Use puid for logging and audit purposes

Common Use Cases:

  • Verifying API key validity and partner status

  • Displaying partner information in admin dashboards

  • Conditional logic based on partner status

  • Audit logging with partner context

  • Multi-tenant application context switching

Security Considerations:

  • API keys should be stored securely

  • Rotate API keys regularly for security

  • Monitor partner status for access control

  • Implement rate limiting based on partner tier

Integration Tips:

  • Call this endpoint during application startup to verify connectivity

  • Use the response to configure partner-specific settings

  • Cache the response to avoid frequent API calls

  • Handle status changes gracefully in your application

Request sample

Response sample

Last updated