# catalogs/recipients/relationships

## Purpose
Returns the list of available relationship types between sender and recipient. Used for compliance and KYC data collection.
## When to Use
Use this endpoint when you need to:
- Populate relationship type dropdowns in the beneficiary/recipient forms
- Validate the sender-recipient relationship before submitting a transaction
- Display available relationship options (e.g., parent, spouse, friend, business)

## Authentication
Requires `x-client-id` and `x-secret-key` headers for partner authentication.
## Notes
- The relationship types are global and not country-specific
- This field may be required depending on the destination country's compliance rules
- The relationship `id` is used when creating or updating beneficiary records
- Each relationship includes `translations` with English (`en`) and Spanish (`es`) names

## Common Errors
- `400` Validation errors (missing/invalid fields)
- `401` Invalid credentials
- `404` Resource not found
- `500` Internal error

<details><summary><b>Error codes (click to expand)</b></summary><table style='border-collapse:collapse; width:100%; margin-top:8px;'><thead><tr><th style='border:1px solid #e5e7eb; padding:6px; text-align:left;'>Code</th><th style='border:1px solid #e5e7eb; padding:6px; text-align:left;'>Description</th></tr></thead><tbody><tr><td style='border:1px solid #e5e7eb; padding:6px; width:140px;'><code>400000</code></td><td style='border:1px solid #e5e7eb; padding:6px;'>Invalid request format</td></tr><tr><td style='border:1px solid #e5e7eb; padding:6px; width:140px;'><code>400001</code></td><td style='border:1px solid #e5e7eb; padding:6px;'>x-client-id is required</td></tr><tr><td style='border:1px solid #e5e7eb; padding:6px; width:140px;'><code>400005</code></td><td style='border:1px solid #e5e7eb; padding:6px;'>x-secret-key is required</td></tr><tr><td style='border:1px solid #e5e7eb; padding:6px; width:140px;'><code>401000</code></td><td style='border:1px solid #e5e7eb; padding:6px;'>Invalid credentials</td></tr><tr><td style='border:1px solid #e5e7eb; padding:6px; width:140px;'><code>404000</code></td><td style='border:1px solid #e5e7eb; padding:6px;'>No relationship types found</td></tr><tr><td style='border:1px solid #e5e7eb; padding:6px; width:140px;'><code>500000</code></td><td style='border:1px solid #e5e7eb; padding:6px;'>Internal server error</td></tr></tbody></table></details>

Endpoint: GET /catalogs/recipients/relationships
Version: 1.0.0

## Query parameters:

  - `validations` (string)
    Return validation schema instead of executing the request

Error codes: type=400002, allowedValues=400010

## Header parameters:

  - `x-client-id` (string, required)
    Unique identifier assigned to the integrating client. It determines the validation rules, allowed values, compliance policies, and operational limits applied to the request.

Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

  - `x-secret-key` (string, required)
    Secret authentication key associated with the client. It is used to authorize the request and must be kept strictly confidential.

Error codes: required=400001, type=400002, minLength=400003, maxLength=400004

## Response 200 fields (application/json):

  - `id` (string)
    Unique identifier for the relationship type (e.g. 'AUNT', 'SPOUSE', 'FRIEND')

  - `translations` (object)
    Relationship name translations

  - `translations.en` (string)
    Relationship name in English

  - `translations.es` (string)
    Relationship name in Spanish

## Response 400 fields (application/json):

  - `errors` (array)
    List of validation errors.Error catalog for 400 (click to expand)CodeDescription400000Invalid request format400001x-client-id is required400005x-secret-key is required

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

  - `errors.details` (string)

## Response 401 fields (application/json):

  - `errors` (array)
    List of authentication errors.Error catalog for 401 (click to expand)CodeDescription401000Invalid credentials

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

## Response 404 fields (application/json):

  - `errors` (array)
    List of not found errors.Error catalog for 404 (click to expand)CodeDescription404000No relationship types found

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)

## Response 500 fields (application/json):

  - `errors` (array)
    List of server errors.Error catalog for 500 (click to expand)CodeDescription500000Internal server error

  - `errors.status` (string)

  - `errors.code` (number)

  - `errors.message` (string)