Inspections

With these endpoints you will be able to schedule and set as complete your inspections.


PUT/api/v1/orders/{order_id}/schedule_inspection

Schedule inspection

This endpoint allows appraisers to schedule their inspections.

URL attributes

  • Name
    order_id
    Type
    string required
    Description

    The order id.

Form attributes

  • Name
    inspection_scheduled_at
    Type
    string required
    Description

    An ISO8601 date for the inspection date

Request

PUT
/api/v1/orders/{order_id}/schedule_inspection
curl --location --request PUT 'https://app.collateralxp.com/api/v1/orders/{order_id}/schedule_inspection' \
  --header 'X-API-KEY: {api_key}'
  --form 'inspection_scheduled_at="2023-03-08T10:40:00Z"' \

Response

{
  "success": true
}

PUT/api/v1/orders/{order_id}/complete_inspection

Complete inspection

This endpoint allows appraisers to schedule their inspections.

URL attributes

  • Name
    order_id
    Type
    string required
    Description

    The order id.

Request

PUT
/api/v1/orders/{order_id}/complete_inspection
curl --location --request PUT 'https://app.collateralxp.com/api/v1/orders/{order_id}/complete_inspection' \
  --header 'X-API-KEY: {api_key}'

Response

{
  "success": true
}