> ## 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.

# url()

> Verifica si una URL es un sitio de phishing o de estafa con ThreatDetector.url(), que devuelve un estado ALLOWED, BLOCKED, UNKNOWN o IGNORED, además de un redirectUrl opcional.

> [!NOTE]
>
> Solo se verifica la parte del dominio de la URL. La ruta y la cadena de consulta (query string) se
> eliminan antes de enviar la solicitud a la API de ChainPatrol, para preservar la privacidad
> y evitar que se filtre información sensible.

## Ejemplo

```js Code theme={null}
const result = await detector.url("https://www.mountaintop-finance.com");

console.log(result);
```

```js Output (Allowed) theme={null}
{
    ok: true,
    url: "mountaintop-finance.com",
    status: "ALLOWED",
}
```

```js Output (Blocked) theme={null}
{
    ok: true,
    url: "mountaintop-finance.com",
    status: "BLOCKED",
    redirectUrl: "https://app.chainpatrol.io/preview?target=https%3A%2F%2Fwww.mountaintop-finance.com&originUrl=https%3A%2F%2Fwww.mountaintop-finance.com"
}
```

```js Output (Ignored) theme={null}
{
    ok: true,
    url: "https://www.mountaintop-finance.com",
    status: "IGNORED",
}
```

```js Output (Error) theme={null}
{
    ok: false,
    url: "abcdefgh",
    error: "Unable to parse domain"
}
```

## Parámetros

**url** `string` *required*

La URL que se va a verificar. Puede ser una URL completa o un dominio. La URL se
analiza para extraer solo el dominio que se va a verificar.

P. ej., `https://google.com` o `google.com`

## Valor de retorno

El valor de retorno es una promesa que se resuelve con un objeto que contiene el
resultado de la verificación.

### Éxito

Si la verificación se realizó correctamente, el objeto contendrá las siguientes propiedades:

**result** `object` *required*

**propiedades**

**ok** `true` *required*

Esta propiedad será `true` si la verificación se realizó correctamente.

**url** `string`

La propiedad `url` es la URL que se verificó.

**status** `'ALLOWED' | 'BLOCKED' | 'UNKNOWN' | 'IGNORED'` *required*

La propiedad `status` indica si la URL está permitida o bloqueada.
Es `IGNORED` cuando el dominio se agregó con
[`ignore()`](https://chainpatrol.com/docs/es/sdk/threat-detector/instance-methods/ignore), por ejemplo,
después de que un usuario eligió continuar bajo su propio riesgo.

**redirectUrl** `string`

La propiedad `redirectUrl` especifica a dónde redirigir al usuario cuando el
detector detecta una amenaza. Esta propiedad solo estará presente si la
propiedad `status` es `BLOCKED`.

De forma predeterminada, el detector devuelve la página de advertencia de ChainPatrol,
`https://app.chainpatrol.io/preview`, con la URL verificada en los parámetros de consulta `target`
y `originUrl`. Puedes reemplazarla pasando tu
propio `redirectUrl` al crear el `ThreatDetector`.

### Error

En cambio, si la verificación no se pudo realizar, el objeto contendrá lo siguiente:

**result** `object` *required*

**propiedades**

**ok** `false` *required*

Esta propiedad será `false` si la verificación no se pudo realizar.

**url** `string`

La propiedad `url` es la URL que se verificó.

**error** `string`

La propiedad `error` contendrá un mensaje de error legible para las personas.


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