> For the complete documentation index, see [llms.txt](https://docs.complycube.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.complycube.com/documentation/documentation/documentation-es/guias-rapidas/api-quick-guide/perform-proof-of-address-check.md).
# Realizar comprobación de comprobante de domicilio
### Resumen
Esta guía te muestra cómo realizar una verificación de prueba de domicilio usando la API de ComplyCube.
{% hint style="success" %}
Puedes probar esta verificación de inmediato usando nuestra [Colección de demostración de Postman](/documentation/documentation/documentation-es/recursos-de-integracion/postman.md#demo-collection). Es de acceso público y **no requiere una cuenta**.
{% endhint %}
### Pasos de integración
Guía de la API de verificación de prueba de domicilio
{% stepper %}
{% step %}
#### Crear un cliente
El primer paso para crear cualquier comprobación es añadir un **cliente** desde su servidor backend. Un cliente puede representar a una **persona** o una **empresa**.
La respuesta contendrá un `id` (el ID del cliente). Es necesario para el siguiente paso.
**Ejemplo de solicitud para crear un cliente**
{% tabs %}
{% tab title="cURL" %}
```bash
curl -X POST https://api.complycube.com/v1/clients \\
-H 'Authorization: ' \\
-H 'Content-Type: application/json' \\
-d '{
"type": "person",
"email": "john.doe@example.com",
"personDetails":{
"firstName": "John",
"lastName" :"Doe",
"dob": "1990-01-01"
}
}'
```
{% endtab %}
{% tab title="Node.js" %}
```javascript
const { ComplyCube } = require("@complycube/api");
const complycube = new ComplyCube({ apiKey: "" });
const client = await complycube.client.create({
type: "person",
email: "john.doe@example.com",
personDetails: {
firstName: "John",
lastName: "Doe",
dob: "1990-01-01"
}
});
```
{% endtab %}
{% tab title="Python" %}
```python
from complycube import ComplyCubeClient
cc_api = ComplyCubeClient(api_key='')
new_client = {
'type':'person',
'email':'john.doe@example.com',
'personDetails': {
'firstName':'John',
'lastName':'Doe',
'dob':'1990-01-01'
}
}
client = cc_api.clients.create(**new_client)
```
{% endtab %}
{% tab title="PHP" %}
```php
use ComplyCube\ComplyCubeClient;
$ccapi = new ComplyCubeClient('');
$result = $ccapi->clients()->create([
'type' => 'person',
'email' => 'john.doe@example.com',
'personDetails' => [
'firstName' => 'John',
'lastName' => 'Doe',
'dob' => '1990-01-01'
]
]);
```
{% endtab %}
{% tab title=".NET" %}
```csharp
using ComplyCube.Net;
using ComplyCube.Net.Resources.Clients;
var clientApi = new ClientApi(new ComplyCubeClient(""));
var newclient = new ClientRequest {
type = "person",
email = "john.doe@example.com",
personDetails = new PersonDetails {
firstName = "John",
lastName = "Doe",
dob = "1990-01-01"
}
}
var client = await clientApi.CreateAsync(newclient);
```
{% endtab %}
{% endtabs %}
**Respuesta de ejemplo**
```json
{
"id": "5eb04fcd0f3e360008035eb1",
"type": "person",
"email": "john.doe@example.com",
"personDetails": {
"firstName": "John",
"lastName": "Doe",
"dob": "1990-01-01"
},
"createdAt": "2025-01-04T17:24:29.146Z",
"updatedAt": "2025-01-04T17:24:29.146Z"
}
```
{% endstep %}
{% step %}
#### Crear una dirección
Crea una dirección proporcionando la **ID del cliente** y los detalles de la dirección.
La respuesta contendrá un `id` (el ID de la dirección). Se requerirá más tarde.
**Ejemplo de solicitud para crear una dirección**
{% tabs %}
{% tab title="cURL" %}
```bash
curl -X POST https://api.complycube.com/v1/addresses \
-H 'Authorization: ' \\
-H 'Content-Type: application/json' \\
-d '{
"clientId":"5eb04fcd0f3e360008035eb1",
"line": "47th Test Avenue 323",
"city": "Manhattan",
"postalCode": "10001",
"state": "NY",
"country": "US"
}'
```
{% endtab %}
{% tab title="Node.js" %}
```javascript
const address = await complycube.address.create("5eb04fcd0f3e360008035eb1", {
line: "47th Test Avenue 323",
city: "Manhattan",
postalCode: "10001",
state: "NY",
country: "US"
});
```
{% endtab %}
{% tab title="Python" %}
```python
new_address = {
'line': '47th Test Avenue 323',
'city': 'Manhattan',
'postalCode': '10001',
'state': 'NY',
'country': 'US'
}
address = cc_api.addresses.create('5eb04fcd0f3e360008035eb1',**new_address)
```
{% endtab %}
{% tab title="PHP" %}
```php
$address = $ccapi->address()->create(
'5eb04fcd0f3e360008035eb1',
[
'line' => '47th Test Avenue 323',
'city' => 'Manhattan',
'postalCode' => '10001',
'state' => 'NY',
'country' => 'US'
]
);
```
{% endtab %}
{% tab title=".NET" %}
```csharp
var addressRequest = new AddressRequest {
clientId = "5eb04fcd0f3e360008035eb1",
line = "47th Test Avenue 323",
city = "Manhattan",
postalCode = "10001",
state = "NY",
country = "US"
};
var address = await addressApi.CreateAsync(addressRequest);
```
{% endtab %}
{% endtabs %}
**Respuesta de ejemplo**
```json
{
"id": "5ebd40714f23960008c81528",
"clientId":"5eb04fcd0f3e360008035eb1",
"line": "47th Test Avenue 323",
"city": "Manhattan",
"postalCode": "10001",
"state": "NY",
"country": "US",
"createdAt": "2021-01-04T17:25:21.116Z",
"updatedAt": "2021-01-04T17:25:21.116Z"
}
```
{% endstep %}
{% step %}
#### Crear un documento
Crea un documento proporcionando el **ID del cliente** y **tipo de documento** (p. ej., un extracto bancario).
La respuesta contendrá un `id` (el ID del documento). Es necesario para el siguiente paso.
**Solicitud de ejemplo para crear un documento**
{% tabs %}
{% tab title="cURL" %}
```bash
curl -X POST https://api.complycube.com/v1/documents \
-H 'Authorization: ' \
-H 'Content-Type: application/json' \
-d '{
"clientId":"5eb04fcd0f3e360008035eb1",
"type": "bank_statement"
}'
```
{% endtab %}
{% tab title="Node.js" %}
```javascript
const document = await complycube.document.create("5eb04fcd0f3e360008035eb1", {
type: "bank_statement"
});
```
{% endtab %}
{% tab title="Python" %}
```python
document = cc_api.documents.create(
'5eb04fcd0f3e360008035eb1',
type='bank_statement'
)
```
{% endtab %}
{% tab title="PHP" %}
```php
$doc = $ccapi->documents()->create(
'5eb04fcd0f3e360008035eb1',
['type' => 'bank_statement']
);
```
{% endtab %}
{% tab title=".NET" %}
```csharp
var docRequest = new DocumentRequest {
clientId = "5eb04fcd0f3e360008035eb1",
type = "bank_statement"
};
var document = await docApi.CreateAsync(docRequest);
```
{% endtab %}
{% endtabs %}
**Respuesta de ejemplo**
La respuesta contendrá un `id` (el ID del documento). Es necesario para el siguiente paso.
```json
{
"id": "5ebd40714f23960008c81527",
"type": "bank_statement",
"createdAt": "2025-01-04T17:25:21.116Z",
"updatedAt": "2025-01-04T17:25:21.116Z"
}
```
{% endstep %}
{% step %}
#### Subir documento
Sube una imagen codificada en BASE64 del documento de prueba de domicilio.
Las imágenes deben estar en **JPG**, **PNG**, o **PDF** formato y tener entre **34 KB** y **4 MB** .
A continuación se muestra un archivo de ejemplo codificado en BASE64. Descárgalo, copia su contenido y pégalo en el `data` atributo al hacer la solicitud.
{% file src="/files/a501ab1c9c44bc15b3f7083d7a77a05e2d0d401f" %}
Ejemplo: extracto bancario codificado en BASE64
{% endfile %}
**Solicitud de ejemplo para subir la imagen de un documento**
{% tabs %}
{% tab title="cURL" %}
```bash
curl -X POST https://api.complycube.com/v1/documents/5ebd40714f23960008c81527/upload/front \
-H 'Authorization: ' \
-H 'Content-Type: application/json' \
-d '{
"fileName": "bank-statement-sample.pdf",
"data": ""
}'
```
{% endtab %}
{% tab title="Node.js" %}
```javascript
const frontImage = await complycube.document.upload("5ebd40714f23960008c81527", {
fileName: "bank-statement-sample.pdf",
data: ""
}, "front");
```
{% endtab %}
{% tab title="Python" %}
```python
front_image = cc_api.documents.upload(
'5ebd40714f23960008c81527',
'front',
fileName='bank-statement-sample.pdf',
data=''
)
```
{% endtab %}
{% tab title="PHP" %}
```php
$up = $ccapi->documents()->upload(
'5ebd40714f23960008c81527',
'front',
[
'fileName' => 'bank-statement-sample.pdf',
'data' => ''
]
);
```
{% endtab %}
{% tab title=".NET" %}
```csharp
var docFront = new ImageRequest {
fileName = "bank-statement-sample.pdf",
data = ""
};
var img = await docApi.UploadImageAsync(
"5ebd40714f23960008c81527",
"front",
docFront
);
```
{% endtab %}
{% endtabs %}
**Respuesta de ejemplo**
La respuesta contendrá un `id` (el ID de la imagen). Es necesario para el siguiente paso.
```json
{
"id": "5eb169302d868c0008828591",
"fileName": "bank-statement-sample.pdf",
"documentSide": "front",
"downloadLink": "/documents/5ebd40714f23960008c81527/images/5eb169302d868c0008828591/download",
"contentType": "application/pdf",
"size": 182716,
"createdAt": "2025-01-04T17:25:21.116Z",
"updatedAt": "2025-01-04T17:25:21.116Z"
}
```
{% endstep %}
{% step %}
#### Crear una verificación de prueba de domicilio
Crea una verificación de prueba de domicilio proporcionando el **ID del cliente**, **ID del documento**, y **tipo de comprobación**.
La respuesta contendrá un `id` (el ID de la comprobación). Es necesario para el siguiente paso.
**Ejemplo de solicitud para crear una comprobación**
{% tabs %}
{% tab title="cURL" %}
```bash
curl -X POST https://api.complycube.com/v1/checks \
-H 'Authorization: ' \
-H 'Content-Type: application/json' \
-d '{
"clientId":"5eb04fcd0f3e360008035eb1",
"documentId":"5ebd40714f23960008c81527",
"type": "proof_of_address_check"
}'
```
{% endtab %}
{% tab title="Node.js" %}
```javascript
const check = await complycube.check.create("5eb04fcd0f3e360008035eb1", {
documentId: "5ebd40714f23960008c81527",
type: "proof_of_address_check"
});
```
{% endtab %}
{% tab title="Python" %}
```python
check = cc_api.checks.create(
'5eb04fcd0f3e360008035eb1',
'proof_of_address_check',
documentId='5ebd40714f23960008c81527'
)
```
{% endtab %}
{% tab title="PHP" %}
```php
$result = $ccapi->checks()->create(
'5eb04fcd0f3e360008035eb1',
[
'type' => 'proof_of_address_check',
'documentId' => '5ebd40714f23960008c81527'
]
);
```
{% endtab %}
{% tab title=".NET" %}
```csharp
var checkRequest = new CheckRequest {
clientId = "5eb04fcd0f3e360008035eb1",
documentId = "5ebd40714f23960008c81527",
type = "proof_of_address_check"
};
var check = await checkApi.CreateAsync(checkRequest);
```
{% endtab %}
{% endtabs %}
**Respuesta de ejemplo**
```json
{
"id": "65c12a6426d2ab000814037e",
"entityName": "John Doe",
"type": "proof_of_address_check",
"clientId": "5eb04fcd0f3e360008035eb1",
"documentId": "5ebd40714f23960008c81527",
"status": "pendiente",
"createdAt": "2025-01-04T17:25:21.116Z",
"updatedAt": "2025-01-04T17:25:21.116Z"
}
```
{% endstep %}
{% step %}
#### Recuperar resultados
ComplyCube ejecutará entonces la comprobación. Puedes recuperar su [resultado y desglose detallado](/documentation/api-reference/check-types/proof-of-address-check.md#result-object) a través de la API, o revisar los resultados en el Portal.
Si has [configurado webhooks](/documentation/documentation/documentation-es/recursos-de-integracion/webhooks.md), también recibirás una notificación una vez que la comprobación se haya completado.
**Ejemplo de solicitud para recuperar el resultado de la comprobación**
{% tabs %}
{% tab title="cURL" %}
```bash
curl -X GET https://api.complycube.com/v1/checks/5ebd40714f23960008c81527 \
-H 'Authorization: '
```
{% endtab %}
{% tab title="Node.js" %}
```javascript
const check = await complycube.check.get("5ebd40714f23960008c81527");
```
{% endtab %}
{% tab title="Python" %}
```python
check = cc_api.checks.get('5ebd40714f23960008c81527')
```
{% endtab %}
{% tab title="PHP" %}
```php
$check = $ccapi->checks()->get('5ebd40714f23960008c81527');
```
{% endtab %}
{% tab title=".NET" %}
```csharp
var check = await checkApi.GetAsync("5ebd40714f23960008c81527");
```
{% endtab %}
{% endtabs %}
**Respuesta de ejemplo**
```json
{
"id": "65c12a6426d2ab000814037e",
"entityName": "John Doe",
"type": "proof_of_address_check",
"clientId": "5eb04fcd0f3e360008035eb1",
"documentId": "5ebd40714f23960008c81527",
"status": "completado",
"result": {
"outcome": "sin incidencias",
"breakdown": {
"extractedData": {
"holderDetails": {
"entityName": "John Doe"
},
"documentDetails": {
"documentType": "bank_statement",
"issuer": "Barclays Bank",
"issuingDate": {
"day": 25,
"month": 1,
"year": 2021
}
},
"addressDetails": {
"address": {
"propertyNumber": "323",
"line": "Common street",
"city": "Aldgate",
"state": "London",
"postalCode": "W99 0RD",
"country": "GB",
"latLong": "51.5136,-0.077188"
},
"addressLine": "323 Common Street Aldgate London W99 0RD",
"addressCountry": "GB"
}
},
"clientValidation": {
"firstName": "sin incidencias",
"lastName": "sin incidencias",
"address": "clear"
},
"contentAnalysis": {
"documentAge": "clear"
},
"geoLocationAnalysis": {
"ipInAddressCountry": "clear",
"ipProximityToAddress": "clear"
}
}
},
"createdAt": "2025-01-04T17:25:21.116Z",
"updatedAt": "2025-01-04T17:25:21.116Z"
}
```
{% endstep %}
{% endstepper %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.complycube.com/documentation/documentation/documentation-es/guias-rapidas/api-quick-guide/perform-proof-of-address-check.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.