# Credential actions

3 management API operations.

- [GET /v1/me/credential-actions](/docs/api/operations/capabilities_v1_me_credential_actions_get): Capabilities
- [POST /v1/me/credential-actions](/docs/api/operations/start_v1_me_credential_actions_post): Start
- [POST /v1/me/credential-actions/{intent_id}/complete](/docs/api/operations/complete_v1_me_credential_actions__intent_id__complete_post): Complete

## GET /v1/me/credential-actions

Capabilities

Capabilities

Authentication: bearer access token with audience `taifa-management`. Endpoint roles and eligibility are reviewed separately from the OpenAPI bearer scheme.

No operation-specific scopes are declared in the OpenAPI document. Bearer authentication and endpoint authorization requirements still apply.

### Parameters

No path or query parameters declared.

### Request body

This operation has no request body.

### Responses

#### 200

Successful Response

No fields declared in the current specification.

### Request examples

Illustrative only. Replace placeholders and keep management tokens on the server.

#### cURL

```sh
curl -X GET 'https://YOUR_IDENTITY_HOST/v1/me/credential-actions' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
```

#### TypeScript (Node.js/server-side)

```typescript
const response = await fetch('https://YOUR_IDENTITY_HOST/v1/me/credential-actions', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.TAIFA_MANAGEMENT_TOKEN}`
  }
});

const result = await response.json();
```

#### Python

```python
import os
import requests

response = requests.request(
    'GET',
    'https://YOUR_IDENTITY_HOST/v1/me/credential-actions',
    headers={'Authorization': 'Bearer ' + os.environ['TAIFA_MANAGEMENT_TOKEN']}
)
response.raise_for_status()
```

### Response example

No response example in the current specification.


[Request and response examples](/docs/api/operations/capabilities_v1_me_credential_actions_get)

## POST /v1/me/credential-actions

Start

Start

Authentication: bearer access token with audience `taifa-management`. Endpoint roles and eligibility are reviewed separately from the OpenAPI bearer scheme.

No operation-specific scopes are declared in the OpenAPI document. Bearer authentication and endpoint authorization requirements still apply.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `idempotency-key` | header | string \| null | No |  |
| `x-portal-binding` | header | string \| null | No |  |

### Request body

#### application/json

Required; StartAction

| Field | Variant | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `action` |  | string | Yes | Validation: min length 1; max length 64 |
| `reason` |  | string | Yes | Validation: min length 8; max length 500 |

### Responses

#### 201

Successful Response

No fields declared in the current specification.

#### 422

Validation Error

| Field | Variant | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `detail` |  | ValidationError[] | No |  |

### Request examples

Illustrative only. Replace placeholders and keep management tokens on the server.

#### cURL

```sh
curl -X POST 'https://YOUR_IDENTITY_HOST/v1/me/credential-actions' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'idempotency-key: REPLACE_WITH_IDEMPOTENCY_KEY' \
  -H 'Content-Type: application/json' \
  --data '{
  "action": "REPLACE_WITH_ACTION",
  "reason": "REPLACE_WITH_REASON"
}'
```

#### TypeScript (Node.js/server-side)

```typescript
const response = await fetch('https://YOUR_IDENTITY_HOST/v1/me/credential-actions', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TAIFA_MANAGEMENT_TOKEN}`,
    'idempotency-key': 'REPLACE_WITH_IDEMPOTENCY_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "action": "REPLACE_WITH_ACTION",
  "reason": "REPLACE_WITH_REASON"
})
});

const result = await response.json();
```

#### Python

```python
import os
import json
import requests

response = requests.request(
    'POST',
    'https://YOUR_IDENTITY_HOST/v1/me/credential-actions',
    headers={'Authorization': 'Bearer ' + os.environ['TAIFA_MANAGEMENT_TOKEN'], 'idempotency-key': 'REPLACE_WITH_IDEMPOTENCY_KEY'},
    json=json.loads('{"action":"REPLACE_WITH_ACTION","reason":"REPLACE_WITH_REASON"}')
)
response.raise_for_status()
```

### Response example

No response example in the current specification.


[Request and response examples](/docs/api/operations/start_v1_me_credential_actions_post)

## POST /v1/me/credential-actions/{intent_id}/complete

Complete

Complete

Authentication: bearer access token with audience `taifa-management`. Endpoint roles and eligibility are reviewed separately from the OpenAPI bearer scheme.

No operation-specific scopes are declared in the OpenAPI document. Bearer authentication and endpoint authorization requirements still apply.

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `intent_id` | path | string | Yes |  |
| `idempotency-key` | header | string \| null | No |  |
| `x-portal-binding` | header | string \| null | No |  |

### Request body

#### application/json

Required; FinishAction

| Field | Variant | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `callback_status` |  | string | Yes | Validation: pattern ^(success\|canceled\|error)$ |

### Responses

#### 200

Successful Response

No fields declared in the current specification.

#### 422

Validation Error

| Field | Variant | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `detail` |  | ValidationError[] | No |  |

### Request examples

Illustrative only. Replace placeholders and keep management tokens on the server.

#### cURL

```sh
curl -X POST 'https://YOUR_IDENTITY_HOST/v1/me/credential-actions/REPLACE_WITH_INTENT_ID/complete' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'idempotency-key: REPLACE_WITH_IDEMPOTENCY_KEY' \
  -H 'Content-Type: application/json' \
  --data '{
  "callback_status": "REPLACE_WITH_CALLBACK_STATUS"
}'
```

#### TypeScript (Node.js/server-side)

```typescript
const response = await fetch('https://YOUR_IDENTITY_HOST/v1/me/credential-actions/REPLACE_WITH_INTENT_ID/complete', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.TAIFA_MANAGEMENT_TOKEN}`,
    'idempotency-key': 'REPLACE_WITH_IDEMPOTENCY_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
  "callback_status": "REPLACE_WITH_CALLBACK_STATUS"
})
});

const result = await response.json();
```

#### Python

```python
import os
import json
import requests

response = requests.request(
    'POST',
    'https://YOUR_IDENTITY_HOST/v1/me/credential-actions/REPLACE_WITH_INTENT_ID/complete',
    headers={'Authorization': 'Bearer ' + os.environ['TAIFA_MANAGEMENT_TOKEN'], 'idempotency-key': 'REPLACE_WITH_IDEMPOTENCY_KEY'},
    json=json.loads('{"callback_status":"REPLACE_WITH_CALLBACK_STATUS"}')
)
response.raise_for_status()
```

### Response example

No response example in the current specification.


[Request and response examples](/docs/api/operations/complete_v1_me_credential_actions__intent_id__complete_post)