Get document by id

GET

/api/documents/{id}

curl --request GET \
  --url https://api.getvespy.com/api/documents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Production
• Development
• Local

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Default Response

Media typeapplication/json

object

document

required

object

aiAnalysis

required

object

analyzedAt

required

Any of:

string

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/

null

null

error

required

Any of:

object

object

code

required

string

>= 1 characters <= 80 characters

message

required

string

>= 1 characters <= 500 characters

null

null

model

required

Any of:

string

string

>= 1 characters <= 255 characters

null

null

result

required

Any of:

object

Any of:

object

One of:

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

endDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

landlordNames

required

Array<string>

propertyAddress

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

rentAmountCents

required

Any of:

integer

integer

<= 9007199254740991

null

null

securityDepositCents

required

Any of:

integer

integer

<= 9007199254740991

null

null

startDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

tenantNames

required

Array<string>

documentType

required

string

Allowed values: lease

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

coverageTypes

required

Array<string>

effectiveDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

expirationDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

insuredName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

insurerName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

policyNumber

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: certificate_of_insurance

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

address

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

businessName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

legalName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

taxClassification

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: w9

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

currency

required

Any of:

string

string

>= 3 characters <= 3 characters

null

null

dueDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

invoiceNumber

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

issueDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

lineItems

required

Array<object>

object

amountCents

required

Any of:

integer

integer

<= 9007199254740991

null

null

description

required

string

>= 1 characters <= 500 characters

quantity

required

Any of:

number

number

null

null

totalAmountCents

required

Any of:

integer

integer

<= 9007199254740991

null

null

vendorName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: invoice_receipt

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

effectiveDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

expirationDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

keyTerms

required

Array<string>

title

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: contract

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

findings

required

Array<string>

inspectionDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

inspectorName

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

propertyAddress

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: inspection

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

effectiveDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

noticeDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

noticeType

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

recipient

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

requiredAction

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: notice

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

currency

required

Any of:

string

string

>= 3 characters <= 3 characters

null

null

periodEnd

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

periodStart

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

statementType

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

totalAmountCents

required

Any of:

integer

integer

<= 9007199254740991

null

null

documentType

required

string

Allowed values: financial_statement

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

effectiveDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

expirationDate

required

Any of:

string

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

null

null

issuingAuthority

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

licenseNumber

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

licenseType

required

Any of:

string

string

>= 1 characters <= 1000 characters

null

null

documentType

required

string

Allowed values: vendor_license

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: document

dates

required

Array<object>

object

date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

label

required

string

>= 1 characters <= 120 characters

details

required

object

keyFacts

required

Array<string>

documentType

required

string

Allowed values: other

parties

required

Array<object>

object

name

required

string

>= 1 characters <= 255 characters

role

required

Any of:

string

string

>= 1 characters <= 120 characters

null

null

summary

required

string

>= 1 characters <= 4000 characters

object

Any of:

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: property_image

visualCategory

required

string

Allowed values: property_exterior property_interior unit damage maintenance amenity general_photo other

visualSummary

required

string

>= 1 characters <= 4000 characters

object

object

confidence

required

number

<= 1

contentKind

required

string

Allowed values: general_image

visualCategory

required

string

Allowed values: property_exterior property_interior unit damage maintenance amenity general_photo other

visualSummary

required

string

>= 1 characters <= 4000 characters

null

null

status

required

string

Allowed values: not_requested queued processing completed failed unsupported

category

required

string

nullable

createdAt

required

string format: date-time

description

required

string

nullable

entityId

required

string format: uuid

nullable

entityType

required

string

nullable

Allowed values: property unit tenant owner payment expense lease vendor work_order charge expense_payment

expiresAt

required

string format: date-time

nullable

id

required

string format: uuid

mimeType

required

string

>= 1 characters <= 255 characters

name

required

string

>= 1 characters <= 255 characters

organizationId

required

string format: uuid

sizeBytes

required

integer

storagePath

required

string

>= 1 characters

tags

required

Array<string>

nullable

updatedAt

required

string format: date-time

uploadedBy

required

string format: uuid

nullable

uploadedByName

required

string

nullable

Example

{
  "document": {
    "aiAnalysis": {
      "result": {
        "contentKind": "document",
        "documentType": "lease"
      },
      "status": "not_requested"
    },
    "entityType": "property"
  }
}

400

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

401

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

403

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}

404

Default Response

Media typeapplication/json

object

code

string

errors

Array<object>

object

code

required

string

message

required

string

path

required

string

message

required

string

Example^generated

{
  "code": "example",
  "errors": [
    {
      "code": "example",
      "message": "example",
      "path": "example"
    }
  ],
  "message": "example"
}