# Reason Code API

## Overview
The Reason Code API allows you to retrieve codes that are associated with various risk signals. You can filter the codes based on product names, exact names, or keywords.

## Parameters

### product
- **Array of strings**  
  Returns only codes for the named product. Repeat the parameter to match several products.

### name
- **Array of strings**  
  Returns only the codes whose name exactly matches the value. Repeat the parameter to request several codes.

### text
- **String**  
  Returns codes whose name or description contains the substring, case-insensitive. Useful for keyword search.

### isActive
- **Boolean**  
  Set to `true` to return only active codes, or `false` to include deprecated codes. When omitted, only active codes are returned.

## Response

### 200
The reason code catalog was retrieved successfully.

#### Object Structure
- **reasonCodes**  
  - **Array of objects**  
    The list of reason codes that match the request.

##### reasonCodes Object
- **name**  
  - *String*  
    The reason code identifier.
- **provider**  
  - *String*  
    The provider that produces the code.
- **description**  
  - *String*  
    Human-readable explanation of the signal.
- **product**  
  - *String*  
    The product the code belongs to. Omitted when the code is not product-specific.
- **isActive**  
  - *Boolean*  
    Whether the code is currently in use.
- **releaseDate**  
  - *Date*  
    The date the code was released (`YYYY-MM-DD`), when available.
- **deprecatedDate**  
  - *Date*  
    The date the code was deprecated (`YYYY-MM-DD`), when applicable.
- **additionalNote**  
  - *String*  
    Supplementary guidance for the code, when available.

## Example Request
```bash
curl --request GET \
     --url https://riskos.socure.com/api/reason-codes \
     --header 'accept: application/json'
```

## Example Response
```json
{
  "reasonCodes": [
    {
      "name": "RXXXX",
      "provider": "Socure",
      "description": "Description of a risk signal.",
      "product": "Email Risk",
      "isActive": true,
      "releaseDate": "2024-03-15"
    },
    {
      "name": "IXXXX",
      "provider": "Socure",
      "description": "Description of an informational signal.",
      "product": "Address Risk",
      "isActive": true
    }
  ]
}
```