Recorded Future Identity API

https://docs.recordedfuture.com/reference/identity-ip
Admin
Recorded Future Identity API is a security intelligence platform that retrieves stolen credentials...
Tokens:761
Snippets:5
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Authentication Methods

Source: https://docs.recordedfuture.com/reference/identity-ip

The Recorded Future API supports two primary authentication methods: OAuth2 and API Key. OAuth2 is recommended for most applications, while API Key can be used for simpler integrations.

```APIDOC
## Authentication

The Recorded Future API supports the following authentication methods:

### OAuth2

- **Type**: oauth2
- **Description**: JWT-based OAuth2 security scheme supporting RFC8725 for OAuth 2.0 Access Tokens.
- **Flows**:
  - **authorizationCode**:
    - **authorizationUrl**: `https://id.recordedfuture.com/authorize`
    - **tokenUrl**: `https://id.recordedfuture.com/token`
    - **refreshUrl**: `https://id.recordedfuture.com/token`
    - **scopes**: {}

### API Key

- **Type**: apiKey
- **Description**: Use the `X-RFToken` header to provide your API key.
- **In**: header
- **Name**: X-RFToken
```

--------------------------------

### IP Lookup

Source: https://docs.recordedfuture.com/reference/identity-ip

Find credentials compromised from a specific IP address or IP range.

```APIDOC
## POST /identity/ip/lookup

### Description
Find credentials compromised from a specific IP address or IP range.

### Method
POST

### Endpoint
/identity/ip/lookup

### Request Body
- **schema** (object) - Required - The request body must be a JSON object conforming to the IpLookupRequest schema.

### Responses
#### Success Response (200)
- **schema** (object) - The response will contain a LookupResponse object detailing compromised credentials.

#### Error Responses
- **400 Bad Request**: The request was malformed or invalid.
- **401 Unauthorized**: Authentication credentials were not provided or were invalid.
- **403 Forbidden**: The authenticated user does not have permission to access this resource.
- **500 Internal Server Error**: An unexpected error occurred on the server.
```

--------------------------------

### Error Responses

Source: https://docs.recordedfuture.com/reference/identity-ip

The API returns standardized error responses to indicate issues with requests. Common errors include forbidden access and internal server errors.

```APIDOC
## Error Responses

### Forbidden Access Response

- **Description**: Returned when the client does not have permission to access the requested resource.
- **Status Code**: 403
- **Content**: 
```json
{
  "message": "Access to the requested resource is forbidden.",
  "status_code": 403,
  "trace_id": "fa1d4940-f35f-4dc1-84d1-de2f27a8b95e"
}
```

### Internal Server Error Response

- **Description**: Returned when an unexpected error occurs on the server.
- **Status Code**: 500
- **Content**: 
```json
{
  "message": "An internal server error occurred.",
  "status_code": 500,
  "trace_id": "fa1d4940-f35f-4dc1-84d1-de2f27a8b95e"
}
```
```
Tokens:
Raw