> For the complete documentation index, see [llms.txt](https://docs.delos.financial/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.delos.financial/partner/get-partner.md).

# 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**

{% embed url="<https://stagep.tst-apidmndelss.com/openapi/v2.html#/operations/Auth_Partner>" %}

### **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:**

```json
{
  "item": {
    "puid": "partner_abc123def",
    "name": "Acme Corporation",
    "status": "ACCEPT"
  }
}
```

***

### **Examples**

#### **Basic Partner Retrieval (cURL)**

```bash
curl --request GET \
  --url https://stagep.tst-apidmndelss.com/v2/auth/partner \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer eyJhbGci...wNLGA'
```

***

### **Error Responses**

1. **Unauthorized**:

   ```json
   { "error": "Unauthorized" }
   ```
2. **Invalid API Key**:

   ```json
   { "error": "Invalid authentication token" }
   ```
3. **Partner Not Found**:

   ```json
   { "error": "Partner not found for provided credentials" }
   ```

***

### **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

```
Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjE2NCwiZXhwIjoxNzYxNTczMTA0LCJrZXkiOiI1Y2ZiOGZjN2RmYjk4ZjVkYmIyZTgwNTVkZWFhN2U2Zjk4MzEyYmE3Iiwib3RwX3ZlcmlmaWVkIjpmYWxzZX0.oSBPLvobjQwI5LwfFtWnmUdbnPedujraitSDnW8m3zw
```

Response sample

```postman_json
{
  "item": {
    "id": "3354815d-1a23-4b1c-81ec-306388cddfa4",
    "name": "Delos test",
    "status": "NEW",
    "logo": null
  }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.delos.financial/partner/get-partner.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.