---
title: "Get the customer-account requirement"
method: GET
path: "/transactions/{transactionId}/account-requirement"
tags: ["Transactions"]
---

# Get the customer-account requirement

`GET /transactions/{transactionId}/account-requirement`

## Request

- Base URL: `https://api.darwin.so/api/v1`
- URL: `https://api.darwin.so/api/v1/transactions/{transactionId}/account-requirement`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer

User credentials only. Returns the provider, scopes, retention choices, and current authorization state needed after funding and before fulfillment.

## Path parameters

- `transactionId` string, required

## Query parameters

- `aiId` string

## Response `200`

The post-funding external-account requirement.

- object
  - `accountRequirement` TransactionAccountRequirement, required
    - `transactionId` string, required
    - `transactionStatus` string, required
    - `requirement` 'NONE' | 'OPTIONAL' | 'REQUIRED', required
    - `providerKey` string, nullable, required
    - `requiredScopes` string[], required
    - `allowedRetention` string[], required
    - `status` 'NOT_REQUIRED' | 'OPTIONAL_MISSING' | 'REQUIRED' | 'AUTHORIZED', required
    - `missingScopes` string[], required

## Other responses

- `400`: The request was invalid.
- `401`: The API key or access token is missing, invalid, expired, or revoked.
- `403`: The principal does not have the required scope or resource access.
- `404`: The resource was not found for this principal.

---

[API](https://skmtc.dev/darwin/apis/darwin-api.md) · [All operations](https://skmtc.dev/darwin/apis/darwin-api/llms.txt) · [OpenAPI document](https://skmtc.dev/darwin/apis/darwin-api/revisions/56166fce7bfb?raw)