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

# Como buscar una cuenta

> Aprende cómo obtener el firmante asociado a un alias utilizando la API de Transfiya.

# Cómo consultar una cuenta - Versión 1

Esta guía está destinada para que las Entidades Participantes que desean validar si un usuario receptor se encuentra creado en de Transfiya (signer).

Un Signer es una representación de una credencial de pago en Transfiya, dentro de cada creación de Signer se almacena la información del usuario y la información de la cuenta, y debido a esto, las Entidades pueden hacer una búsqueda con la información del usuario y del banco para obtener el signer registrado.

## Filtros disponibles para obtener un signer por datos del beneficiario:

Puedes usar los siguientes filtros en el endpoint `POST [baseUrl]/v1/signer/lookup`:

* `labels.proprietary`
* `labels.identification`
* `labels.bankAccountNumber`
* `labels.routerReference`

### Campos de entrada:

| **Etiqueta**     | **Descripción**                                               | **Tipo** | **Longitud**                                                 | **Obligatoriedad** |
| :--------------- | :------------------------------------------------------------ | :------- | :----------------------------------------------------------- | :----------------- |
| proprietary      | Tipo de documento, admite: CC,CE,PA,TI,NUIP,NIT,OTR,PPT y PEP | Texto    | 1-4                                                          | Si                 |
| identification   | Número de documento                                           | Texto    | 1-18 carácteres                                              | Si                 |
| bankAccounNumber | Número de cuenta                                              | Texto    | 1-Máximo 34 dígitos                                          | Si                 |
| routerReference  | Identificador de billetera del banco en Transfiya.            | Texto    | 1- Máximo 34 caracteres alfanuméricos, debe comenzar con `$` | Si                 |

### Ejemplo de solicitud

```json theme={null}
curl --location 'https://ach-minka-stg.transferenciasinmediatas.com/v1/signer/lookup' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ****' \
--data '{
    "labels": {
        "proprietary": "NIT",
        "identification": "804153241",
        "bankAccountNumber": "335278945",
        "routerReference": "$bancoamarillo"
    }
}'
```

<Tabs>
  <Tab title="Response">
    ```json theme={null}
    {
        "pagination": {
            "pageNum": 0,
            "pageSize": 50
        },
        "error": {
            "code": 0,
            "message": "Success"
        },
        "entities": [
            {
                "handle": "wL62NznU8SPZavTRsy2G3bQ7E2qFL8jpcM",
                "wallets": []
            }
        ]
    }

    ```
  </Tab>
</Tabs>

# Cómo consultar una cuenta - Versión 2

Esta versión del Signer Lookup está destinada para que las Entidades Participantes que desean validar si un usuario receptor se encuentra creado en de Transfiya (signer). Usando como datos de entrada el tipo de identificación y número de identificación del beneficiario.

Transfiya permite a las Entidades, relacionar el caso de uso para ejecutar la respectiva resolución de la información de manera eficiente.

A continuación, se relaciona los valores que permite recibir el campo *useCase:*

| Valor    | Descripción                                                   |
| -------- | ------------------------------------------------------------- |
| b2p-send | Corresponde a una transacción tipo SEND de empresa a persona. |
| b2b-send | Corresponde a una transacción tipo SEND de empresa a empresa. |

### Campos de entrada:

| **Etiqueta**   | **Descripción**                                               | **Tipo** | **Longitud**    | **Obligatoriedad** |
| :------------- | :------------------------------------------------------------ | :------- | :-------------- | :----------------- |
| useCase        | Caso de uso. Admite: b2p-send y b2b-send                      | Texto    | 1-8             | Si                 |
| proprietary    | Tipo de documento, admite: CC,CE,PA,TI,NUIP,NIT,OTR,PPT y PEP | Texto    | 1-4             | Si                 |
| identification | Número de documento                                           | Texto    | 1-18 carácteres | Si                 |

### Ejemplo de solicitud

```json theme={null}
curl --location 'https://ach-minka-stg.transferenciasinmediatas.com/v2/signer/lookup' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ****' \
--data '{
    "useCase": "b2b-send",
    "labels": {
        "proprietary": "NIT",
        "identification": "804153241"
        
        
    }
}
```

Response

```json theme={null}
{
    "entities": [
        {
            "handle": "wWZd85BW1kCj5RgeNET6EC55sG5uGDqpWB",
            "bankName": "Banco Amarillo",
            "bankBicfi": "3854",
            "proprietary": "NIT",
            "identification": "804153241",
            "routerReference": "$bancoamarillo",
            "bankAccountNumber": "335278944"
        },
        {
            "handle": "wL62NznU8SPZavTRsy2G3bQ7E2qFL8jpcM",
            "bankName": "Banco Amarillo",
            "bankBicfi": "3854",
            "proprietary": "NIT",
            "identification": "804153241",
            "routerReference": "$bancoamarillo",
            "bankAccountNumber": "335278945"
        }
    ],
    "error": {
        "code": 0,
        "message": "Success"
    }
}
```

### Lista de códigos de error

A continuación se listan los códigos de error asociados a esta operación:

| **Código de error** | **Descripción**                               | **HTTP Status** |
| :------------------ | :-------------------------------------------- | :-------------- |
| 99                  | Error inesperado del servidor                 | 400             |
| 100                 | No tienes permisos para acceder a este método | 403             |
| 102                 | Etiquetas inválidas                           | 400             |
| 118                 | Error de validación del esquema del recurso   | 400             |
