# Overview

Version: 1.0

## Servers

```
https://api.kycaid.com
```

## Security

### API-Key

Type: apiKey
In: header
Name: API-Key

## Download OpenAPI description

[Overview](https://docs.kycaid.com/_bundle/objects.yaml)

## Addresses

Addresses

### Create address

 - [POST /addresses](https://docs.kycaid.com/objects/addresses/address-create.md): Create and add an address object to an applicant or an affiliated person. Only one address per type may be added to an object

### Update address

 - [PATCH /addresses/{address_id}](https://docs.kycaid.com/objects/addresses/address-update.md): Update records of an address object in our system

In case when an address becomes a part of a created verification, then our system will create a copy of an address object and will provide you with a different address_id in a response

### Delete an address

 - [DELETE /addresses/{address_id}](https://docs.kycaid.com/objects/addresses/address-delete.md): Deletes an address object from our system

Please note, that addresses may be deleted only before a verification was created

## Affiliated persons

Affiliated persons

### Create affiliated person

 - [POST /affiliated-persons](https://docs.kycaid.com/objects/affiliated-persons/affiliated-person-create.md): Create and add an affiliated person for an applicant object

### Update affiliated person

 - [PATCH /affiliated-persons/{affiliated_person_id}](https://docs.kycaid.com/objects/affiliated-persons/affiliated-person-update.md): Update records of an affiliated person object in our system

### Delete an affiliated person

 - [DELETE /affiliated-persons/{affiliated_person_id}](https://docs.kycaid.com/objects/affiliated-persons/affiliated-person-delete.md): Delete records of an affiliated person object from our system

## Applicants

Applicants

### Create applicant

 - [POST /applicants](https://docs.kycaid.com/objects/applicants/applicant-create.md): Create a new applicant object in the system

### Get applicant

 - [GET /applicants/{applicant_id}](https://docs.kycaid.com/objects/applicants/applicant-get.md): Get data on a created applicant

### Update an applicant

 - [PATCH /applicants/{applicant_id}](https://docs.kycaid.com/objects/applicants/applicant-update.md): Update data of a created applicant

## Documents

Documents

### Create document

 - [POST /documents](https://docs.kycaid.com/objects/documents/document-create.md): Create a new document object in our system

### Get document

 - [GET /documents/{document_id}](https://docs.kycaid.com/objects/documents/document-get.md): Get records of a created document object

### Update a document

 - [PATCH /documents/{document_id}](https://docs.kycaid.com/objects/documents/document-update.md): Update records of a created document object

### Delete a document

 - [DELETE /documents/{document_id}](https://docs.kycaid.com/objects/documents/document-delete.md): Delete records of a created document object

## Files

Files

### Create file

 - [POST /files](https://docs.kycaid.com/objects/files/file-create.md): {% admonition type="info" name="Content migration in progress" %}
  Please refer to the legacy documentation for this article
{% /admonition %}

### Update file

 - [PUT /files/file_id](https://docs.kycaid.com/objects/files/file-update.md): {% admonition type="info" name="Content migration in progress" %}
  Please refer to the legacy documentation for this article
{% /admonition %}

## Forms

Forms

### Get a form URL

 - [POST /forms/{form_id}/urls](https://docs.kycaid.com/objects/forms/form-get-url.md): Retrieve a URL for a form

### Get forms

 - [GET /forms](https://docs.kycaid.com/objects/forms/forms-get.md): {% admonition type="info" name="Content migration in progress" %}
  Please refer to the legacy documentation for this article
{% /admonition %}

## Verifications

Verifications

### Create verification

 - [POST /verifications](https://docs.kycaid.com/objects/verifications/verification-create.md): {% admonition type="info" name="Content migration in progress" %}
  Please refer to the legacy documentation for this article
{% /admonition %}

### Get verification

 - [GET /verifications/{verification_id}](https://docs.kycaid.com/objects/verifications/verification-get.md): {% admonition type="info" name="Content migration in progress" %}
  Please refer to the legacy documentation for this article
{% /admonition %}

### Get a report

 - [GET /verifications/report](https://docs.kycaid.com/objects/verifications/verification-report-get.md): {% admonition type="info" name="Content migration in progress" %}
  Please refer to the legacy documentation for this article
{% /admonition %}

### Update verification status

 - [POST /verifications/{verification_id}/status](https://docs.kycaid.com/objects/verifications/verification-update-status.md): This endpoint is used to programmatically change the status of an existing verification record. This is typically utilised by your systems to finalise or adjust a verification's outcome after review

### Get verification report

 - [GET /verifications/{verification_id}/report](https://docs.kycaid.com/objects/verifications/verification-get-report.md): This endpoint is used to retrieve the URL of a verification report for a specific verification record. The returned URL is a signed link that can be used to download the verification report in PDF format.

If the report has not been generated yet, our system will initiate report generation and wait for it to complete. This may take up to 60 seconds.

This endpoint is rate-limited per customer per verification to prevent abuse.