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

# Buscar credenciales en la dark web

> Busca credenciales filtradas vinculadas a un objetivo de la marca incluido en la Allowlist. Las contraseñas se devuelven en texto plano cuando están disponibles. Trata la respuesta como información sensible, usa TLS y nunca registres en logs los cuerpos de las respuestas.

## Inicio rápido

### Autenticación

Incluye tu clave de API en el encabezado `X-API-KEY`:

```bash theme={null}
X-API-KEY: <api-key>
```

## Descripción general

Busca credenciales filtradas que coincidan con un dominio de correo electrónico, una dirección de correo electrónico o una dirección de wallet
que una marca tiene en seguimiento.

> [!WARNING]
>
> Los resultados pueden contener contraseñas en texto plano. Usa siempre HTTPS, restringe y rota las claves de API,
> y no registres en logs los cuerpos de las respuestas ni los expongas a usuarios no autorizados.

## Notas

* `slug` y `brandId` son obligatorios. Encuentra el ID de una marca en
  [Listar marcas de la organización](https://chainpatrol.com/docs/es/external-api/organization-brands.md). Quien hace la llamada debe tener
  acceso a la organización y ser propietario, administrador o miembro del staff. Dark Web Monitoring debe
  estar habilitado.
* `kind` debe ser `domain`, `email` o `crypto`; `target` debe estar en seguimiento en la marca.
  Los objetivos de correo electrónico se normalizan a minúsculas; usa una dirección de wallet sin formato.
* La respuesta incluye el objetivo normalizado, los conteos de resultados y los registros de credenciales
  que coinciden. Las contraseñas pueden ser null; los valores sensibles de los resultados deben manejarse de forma segura.
* Devuelve `400` para objetivos no válidos o que no están en seguimiento, `401` cuando no hay autenticación, `403`
  sin permiso o cuando el monitoreo está deshabilitado, y `404` cuando no se encuentra la
  organización.


## OpenAPI

````yaml POST /dark-web/credentials/search
openapi: 3.0.3
info:
  title: ChainPatrol External API - OpenAPI 3.0
  description: ChainPatrol External API documentation
  version: 2.0.0
servers:
  - url: https://app.chainpatrol.io/api/v2
security: []
tags:
  - name: asset
  - name: report
  - name: dark-web
externalDocs:
  url: https://chainpatrol.com/docs
paths:
  /dark-web/credentials/search:
    post:
      tags:
        - dark-web
      summary: Search leaked credentials
      description: >-
        Search DarkOwl for leaked credentials tied to an allowlisted brand
        target. Passwords are returned in plaintext when available. Treat the
        response as sensitive, use TLS, and never log response bodies.
      operationId: darkWebCredentialsSearch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                slug:
                  type: string
                  minLength: 1
                  description: Organization slug
                brandId:
                  type: integer
                  minimum: 0
                  exclusiveMinimum: true
                  description: Brand ID
                kind:
                  type: string
                  enum:
                    - domain
                    - email
                    - crypto
                  description: Entity type to search
                target:
                  type: string
                  minLength: 1
                  description: Allowlisted brand target to search
              required:
                - slug
                - brandId
                - kind
                - target
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  kind:
                    type: string
                    enum:
                      - domain
                      - email
                      - crypto
                  target:
                    type: string
                  resultCount:
                    type: integer
                    minimum: 0
                  loadedCount:
                    type: integer
                    minimum: 0
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        email:
                          type: string
                          nullable: true
                        address:
                          type: string
                          nullable: true
                        source:
                          type: string
                          nullable: true
                        leakName:
                          type: string
                          nullable: true
                        fragment:
                          type: string
                          nullable: true
                        crawlDate:
                          type: string
                          nullable: true
                        password:
                          type: string
                          nullable: true
                          description: >-
                            Plaintext leaked password when DarkOwl provides one.
                            Treat this response as sensitive and do not log it.
                        passwordType:
                          type: string
                          nullable: true
                      required:
                        - id
                        - email
                        - address
                        - source
                        - leakName
                        - fragment
                        - crawlDate
                        - password
                        - passwordType
                required:
                  - kind
                  - target
                  - resultCount
                  - loadedCount
                  - results
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security:
        - ApiKey: []
components:
  schemas:
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
          description: An array of issues that were responsible for the error
          example: []
      required:
        - message
        - code
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: >-
        Your API key. This is required by most endpoints to access our API
        programatically. Reach out to us at
        [support@chainpatrol.io](mailto:support@chainpatrol.io?subject=Re:%20API%20Key%20for%20SDK&body=Company:%20%0AName:%20%0APurpose:%20)
        to get an API key for your use.

````

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