> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stablepayfi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve recipient field rules

> Retrieve recipient field rules

See [authentication, signing, data conventions, and errors](https://docs.stablepayfi.ai/en/api/global-accounts/overview). Regenerate the timestamp, nonce, and signature on every retry.

`GET /recipient/requirements` Returns required and format rules for each details field, used to render forms.

## Request headers

**Authorization** `string` *required*

Bearer API Key.

**X-StablePay-Timestamp** `string` *required*

Unix seconds, within five minutes of server time.

**X-StablePay-Nonce** `string` *required*

Unique per request, 16–64 characters.

**X-StablePay-Signature** `string` *required*

Lowercase hexadecimal HMAC-SHA256 signature for the exact request body.

## Request parameters

**merchant\_id** `string`

10 digits; omit for merchant apps, required for service-provider apps

**type** `string` *required*

`stablecoin_address` or `fiat_account`

**currency** `string`

Required when type=`fiat_account`

## Response

**recipient\_requirements** `object` *required*

Requirements object

**recipient\_requirements.type** `string` *required*

Recipient type

**recipient\_requirements.currency** `string`

Fiat currency the rules apply to

**recipient\_requirements.fields** `array` *required*

Field rule list

**field** `string` *required*

Field name in details

**required** `boolean` *required*

Whether required

**type** `string` *required*

string or integer

**max\_length** `integer`

Max length

**pattern** `string`

Regex constraint

**description** `string` *required*

Description

**example** `string`

Example value

## Status and errors

404 unsupported currency.

```bash cURL theme={"system"}
curl --request GET \
  --url "https://api.stablepay.co/api/v1/recipient/requirements?type=<TYPE>" \
  --header "Authorization: Bearer <API_KEY>" \
  --header "X-StablePay-Timestamp: <TIMESTAMP>" \
  --header "X-StablePay-Nonce: <NONCE>" \
  --header "X-StablePay-Signature: <SIGNATURE>"
```

```javascript JavaScript theme={"system"}
const response = await fetch("https://api.stablepay.co/api/v1/recipient/requirements?type=<TYPE>", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <API_KEY>",
    "X-StablePay-Timestamp": "<TIMESTAMP>",
    "X-StablePay-Nonce": "<NONCE>",
    "X-StablePay-Signature": "<SIGNATURE>"
  }
});
console.log(await response.json());
```

```json 200 theme={"system"}
{
  "recipient_requirements": {
    "type": "fiat_account",
    "currency": "USD",
    "fields": [
      {
        "field": "account_holder_name",
        "required": true,
        "type": "string",
        "max_length": 140,
        "description": "Account holder name",
        "example": "John Smith"
      },
      {
        "field": "account_number",
        "required": true,
        "type": "string",
        "pattern": "^[0-9]{6,17}$",
        "description": "Local account number",
        "example": "012345678901"
      }
    ]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.