Analyze a document and return transaction suggestions

POST

/import/analyze

const url = 'http://localhost:8000/api/v1/import/analyze';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"file":"binary","document_type":"bank_statement"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:8000/api/v1/import/analyze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "file": "binary", "document_type": "bank_statement" }'

Authorizations

bearerAuth

Request Body^required

application/json

object

file

string format: binary

document_type

string

Allowed values: bank_statement receipt invoice pay_stub utility_bill

Responses

200

Suggestions returned

422

Validation error

500

Server error

Analyze a document and return transaction suggestions

Authorizations

Request Body required

Responses

200

422

500

Request Body^required