# api.yaml


## Servers

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

## Security

### Your API key

Type: apiKey
In: header
Name: Authorization

## Download OpenAPI description

[api.yaml](https://docs.kycaid.com/_spec/api.yaml)

## Addresses

Addresses

### Create an address

 - [POST /addresses](https://docs.kycaid.com/api/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 an address

 - [PATCH /addresses/{address_id}](https://docs.kycaid.com/api/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  in a response


### Delete an address

 - [DELETE /addresses/{address_id}](https://docs.kycaid.com/api/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 an affiliated person

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

### Update an affiliated person

 - [PATCH /affiliated-persons/{affiliated_person_id}](https://docs.kycaid.com/api/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/api/affiliated-persons/affiliated-person-delete.md): Delete records of an affiliated person object from our system

## Applicants

Applicants

### Create an applicant

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

### Get an applicant

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

### Update an applicant

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

## Documents

Documents

### Create a document

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

### Get a document

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

### Update a document

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

### Delete a document

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

## Files

Files

### Create a file

 - [POST /files](https://docs.kycaid.com/api/files/file-create.md): Access the article from the previous version of the documentation:

#### Create file


### Update a file

 - [PUT /files/file_id](https://docs.kycaid.com/api/files/file-update.md): Access the article from the previous version of the documentation:

# Update file


## Forms

Forms

### Get a form URL

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

### Get forms

 - [GET /forms](https://docs.kycaid.com/api/forms/forms-get.md): Access the article from the previous version of the documentation:

# Get forms


## Verifications

Verifications

### Create a verification

 - [POST /verifications](https://docs.kycaid.com/api/verifications/verification-create.md): Access the article from the previous version of the documentation:

# Create verification


### Get a verification

 - [GET /verifications/{verification_id}](https://docs.kycaid.com/api/verifications/verification-get.md): Access the article from the previous version of the documentation:

# Get verification


### Get a report

 - [GET /verifications/report](https://docs.kycaid.com/api/verifications/verification-report-get.md): Access the article from the previous version of the documentation:

# Get verifications report