Applies to integrated customers using the RecoveryConnect API



Photo Operations

The Photo Operations section provides endpoints used to manage photos associated with orders. These endpoints allow users to upload, retrieve, update, and transfer photos related to an order, such as vehicle images, damage photos, and other supporting visual documentation.

All requests must include a valid Bearer token in the request header.

Retrieve Order Photos

DescriptionThis endpoint retrieves the list of photos associated with a specific order.

Order photos may include images captured during the order lifecycle, such as recovery photos, vehicle condition photos, location photos, or other supporting visual documentation attached to the order.

All requests must include a valid Bearer Token in the request header.

URL: /api/v140/orders/{order_id}/photos
Method: GET

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/orders/57076503/photos

 

Request Body: NA

Response:

{

    "data": [

        {

            "id": 180461378,

            "type": {

                "id": 27,

                "name": "Key",

                "always_show": 1,

                "is_required": 1,

                "type": "photos",

                "created_at": "2020-01-20 15:12:16",

                "updated_at": "2022-02-16 11:51:49",

                "deleted_at": null

            },

            "order_attachment_type_id": 27,

            "recovery_has_damage_type_location_id": null,

            "order_id": 57076503,

            "name": "standard-key",

            "photo_url": "https://stg-myrecovery-prod.s3.us-east-2.amazonaws.com/orders/original/10004/424549/2026/03/13/VHTbmZ20zRbz/download.jpeg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEMT%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJIMEYCIQDHUJ2Q8WhRbpvIRJ2H2Ll6kadUzAtwTW9m1WVk%2FqVMvAIhAMrpppocj38bD9fBBeHQcmYrj8nk6%2BgSacvx91DUxjRcKsIFCI3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQAxoMOTU2MTMyMDIxMTg3IgyauXEL2ih1gRuJPj8qlgWVN56grZAx4l1MsoJz3YVMLxOTOmU6gaHiD0CxJ01NNsusrJFsuKHCF2%2BubCEc1b187YjKYXT7dkeChdJJYi7361UoEwoh9H2VzBdJYYFMxb4ravf2GLV8RHdbEuoUgJSDS0R3eNIOUVSCScHmOXQXEYf%2BgdVa5aQPP6U7glabar9I%2B1cX9zcO8BY15XGCcOzEZLs9X%2BUkUKb%2FBFNQIBl%2Fw37rDft657Whk%2BFRgRdVi3yk3EdItOuieR%2B5Egmz4u%2BxoEcMr0u78XuxmhbhafRuk1NM9i0b6GWTAD0131obPlvODbOYy8ZULAR7XsM3Tj7PGxxFsvbB%2BofoMkGoOmPEMZ4gFXKfNFCDurAxsEVd6p0G92fqDbfmuxgiFCmFVAiIbUzPtWXuZxFghjW3yjKs23%2BnpPBqK3XFl5KucF08w1JLVKnf%2FhI%2BOCdt9geIduY2LkwDVNaRZpmHWJSdHctyuhuHpE0j2NqZbEOyE2OPrB7Jx9JC85VEkJipQK88VQnPOOlNv4OIdDv9jk43HGH9b%2FWGWcUg0qOZaEXwGFCgvzPf5qAg3KRJUXP9v%2BdTyhZ533NN3Lzplyh%2FExdExSKO350%2B7DGC%2FPWBvjJejtMsyrVttsT3FGxEYUcOrDBC3TYgAUxkdszMWAk3g7ahimOvriS321ptPktogM4NI4QE7dq9tdqHkjMYHUIBpW6bweTJ3pBlPegB2DNSwGseCiix0QVyZhg5e9EP6ijbqVWxl2qlygbNsQCwXGY4gaIgX1FuNnF3Mlk5DXDKK32UFLVbZxjl4jB4ZNc6dnDgk1RrB0Bk5TjHjH1sVrTZkLrCTlWItnZL7rwVlCm7Rxv89N4WfspbS0FeWW4kvMLsrsel5FVJXQf7NDDH%2Bc%2FNBjqwAcx2tru4%2BTRRmZ5CYKw7TtEp4nWZPl4bwUd%2FhwhLLNZILxPJXFEbkxgEFyC7IdzHl4Zs0fynlDVtAjZI%2BgI%2FDXpk0SEdPvi9bwHEAm9j4hPrFxdmTvmONyskg7jrlXHjFvCc1EFfg%2BiZ6AIF6ICaWyDCGB1cL%2Fqn%2F1u3ohwGb2hTvTqRAHDvaSFsdy%2BeaI6peULZdOyxuR451EePwZx6Y5i2vkMuQTLo9stWaD%2Fkprm0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA55HPI2PB6G6FYPOO%2F20260313%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260313T122835Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=b38ba3644af60caee1572bd4d0df4358c660ca9bf05540bd8588d727cc202ddf",

            "filename": "download.jpeg",

            "uploaded_by": {

                "id": 424549,

                "company_id": 10004,

                "name": "Vinay Forwarder",

                "firstname": "Vinay",

                "lastname": "Forwarder",

                "contact": {

                    "email": "vinay.band@esgit.com",

                    "mobile_phone": null

                },

                "roles": [

                    "Administrator FWD",

                    "Billing Manager",

                    "Billing Staff ",

                    "Billing Supervisor",

                    "Case Worker FWD",

                    "Compliance Officer FWD ",

                    "Field Agent",

                    "Accountant",

                    "MBSiQ",

                    "Transportation FWD"

                ],

                "self": "http://stg-api.mbsisystems.com/api/employees/424549",

                "expand": "employee"

            },

            "parent_attachment_order_id": null,

            "created_at": "2026-03-13 12:28:23",

            "meta": {

                "lat": "0.00000000",

                "long": "0.00000000",

                "generated_at": "2026-03-13 12:28:23",

                "created_at": "2026-03-13T12:28:23.000000Z"

            }

        }

    ],

    "meta": {

        "total": 1

    }

}

 

Create Order Photo

DescriptionThis endpoint uploads and attaches a photo to a specific order.

Order photos are used to document visual information related to the order, such as vehicle condition, recovery location, surroundings, or other supporting evidence. The image must be provided as a Base64 encoded string along with metadata including the file name, image name, capture time, and photo type.

All requests must include a valid Bearer Token in the request header.

URL: /api/v140/orders/{order_id}/photos
Method: POST

Request Body Parameters:

PARAMETER

DESCRIPTION

MANDATORY

EXAMPLE

file_name

Name of the uploaded image file

Yes

test

image_name

Display name or label used to identify the photo

Yes

image name

picture_time

Date and time when the photo was taken

Yes

17-10-2019 23:23

data

Base64 encoded string representing the image file

Yes

iVBORw0KGgoAAAANSUhEUgAAAA…….

type

Identifier representing the photo type

No

2

 

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/orders/57076503/photos

 

Request Body:

{

  "file_name": "test",

  "image_name": "image name",

  "picture_time": "2026-03-11 23:23:00",

  "data": "/9j/4AAQSkZJRgABAQAAAQABAAD…………”,
“type”: 2
 }

 

Response:

{

    "data": {

        "order_id": "57076503",

        "type": 0,

        "case_attachment_type_id": 2,

        "recovery_has_damage_type_location_id": null,

        "attachment_id": 180461379,

        "recovery_id": null

    },

    "status": "success"

}

 

Retrieve Order Photo

DescriptionThis endpoint retrieves the details of a specific photo associated with an order.

Order photos are used to document visual information related to the order, such as vehicle condition, recovery location, surroundings, or other supporting visual evidence. By providing the order ID and photo ID, this endpoint returns the metadata for the specified photo.

All requests must include a valid Bearer Token in the request header.

URL: /api/v140/orders/{order_id}/photos/{photo_id}
Method: GET

Request Body Parameters: NA

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/orders/57076503/photos/180461379

 

Request Body: NA

Response:

{

    "data": {

        "id": 180461379,

        "type": {

            "id": 2,

            "name": "AR General Photo",

            "always_show": 1,

            "is_required": 0,

            "type": "photos",

            "created_at": "2020-01-20 15:12:10",

            "updated_at": "2020-06-27 06:26:39",

            "deleted_at": null

        },

        "order_attachment_type_id": 2,

        "recovery_has_damage_type_location_id": null,

        "order_id": 57076503,

        "name": "standard-a-r-general-photo",

        "photo_url": "https://stg-myrecovery-prod.s3.us-east-2.amazonaws.com/orders/original/10004/408564/2026/03/13/tN2gU9iKA0sT/408564_test.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEMT%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMiJIMEYCIQDHUJ2Q8WhRbpvIRJ2H2Ll6kadUzAtwTW9m1WVk%2FqVMvAIhAMrpppocj38bD9fBBeHQcmYrj8nk6%2BgSacvx91DUxjRcKsIFCI3%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQAxoMOTU2MTMyMDIxMTg3IgyauXEL2ih1gRuJPj8qlgWVN56grZAx4l1MsoJz3YVMLxOTOmU6gaHiD0CxJ01NNsusrJFsuKHCF2%2BubCEc1b187YjKYXT7dkeChdJJYi7361UoEwoh9H2VzBdJYYFMxb4ravf2GLV8RHdbEuoUgJSDS0R3eNIOUVSCScHmOXQXEYf%2BgdVa5aQPP6U7glabar9I%2B1cX9zcO8BY15XGCcOzEZLs9X%2BUkUKb%2FBFNQIBl%2Fw37rDft657Whk%2BFRgRdVi3yk3EdItOuieR%2B5Egmz4u%2BxoEcMr0u78XuxmhbhafRuk1NM9i0b6GWTAD0131obPlvODbOYy8ZULAR7XsM3Tj7PGxxFsvbB%2BofoMkGoOmPEMZ4gFXKfNFCDurAxsEVd6p0G92fqDbfmuxgiFCmFVAiIbUzPtWXuZxFghjW3yjKs23%2BnpPBqK3XFl5KucF08w1JLVKnf%2FhI%2BOCdt9geIduY2LkwDVNaRZpmHWJSdHctyuhuHpE0j2NqZbEOyE2OPrB7Jx9JC85VEkJipQK88VQnPOOlNv4OIdDv9jk43HGH9b%2FWGWcUg0qOZaEXwGFCgvzPf5qAg3KRJUXP9v%2BdTyhZ533NN3Lzplyh%2FExdExSKO350%2B7DGC%2FPWBvjJejtMsyrVttsT3FGxEYUcOrDBC3TYgAUxkdszMWAk3g7ahimOvriS321ptPktogM4NI4QE7dq9tdqHkjMYHUIBpW6bweTJ3pBlPegB2DNSwGseCiix0QVyZhg5e9EP6ijbqVWxl2qlygbNsQCwXGY4gaIgX1FuNnF3Mlk5DXDKK32UFLVbZxjl4jB4ZNc6dnDgk1RrB0Bk5TjHjH1sVrTZkLrCTlWItnZL7rwVlCm7Rxv89N4WfspbS0FeWW4kvMLsrsel5FVJXQf7NDDH%2Bc%2FNBjqwAcx2tru4%2BTRRmZ5CYKw7TtEp4nWZPl4bwUd%2FhwhLLNZILxPJXFEbkxgEFyC7IdzHl4Zs0fynlDVtAjZI%2BgI%2FDXpk0SEdPvi9bwHEAm9j4hPrFxdmTvmONyskg7jrlXHjFvCc1EFfg%2BiZ6AIF6ICaWyDCGB1cL%2Fqn%2F1u3ohwGb2hTvTqRAHDvaSFsdy%2BeaI6peULZdOyxuR451EePwZx6Y5i2vkMuQTLo9stWaD%2Fkprm0&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA55HPI2PB6G6FYPOO%2F20260313%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20260313T124532Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1800&X-Amz-Signature=a0db7162692862d69ca197a017925bbd7f9091f3f7886110f16f40492409b29c",

        "filename": "408564_test.jpg",

        "uploaded_by": {

            "id": 408564,

            "company_id": 10004,

            "name": "sunil Forwarder",

            "firstname": "sunil",

            "lastname": "Forwarder",

            "contact": {

                "email": "sunil.vootkuri@esgit.com",

                "mobile_phone": null

            },

            "roles": [

                "Administrator FWD",

                "Billing Manager",

                "Billing Staff ",

                "Billing Supervisor",

                "Case Worker FWD",

                "Accountant",

                "Compliance Officer FWD ",

                "Field Agent",

                "MBSiQ",

                "Remarketing FWD",

                "Team Lead",

                "Transportation FWD",

                "Vendor Manager",

                "VendorConnect Client",

                "VendorConnect Service Provider"

            ],

            "self": "http://stg-api.mbsisystems.com/api/employees/408564",

            "expand": "employee"

        },

        "parent_attachment_order_id": null,

        "created_at": "2026-03-13 12:40:15",

        "meta": {

            "lat": "0.00000000",

            "long": "0.00000000",

            "generated_at": "2026-03-11 23:23:00",

            "created_at": "2026-03-13T12:40:15.000000Z"

        }

    }

}

 

Transfer Specific Photo of Order

DescriptionThis endpoint transfers a specific photo associated with an order to another order.

The destination order must be provided in the request body using the client order ID. The transfer_to field represents the client order ID of this order where the photo will be transferred.

All requests must include a valid Bearer Token in the request header.

URL: /api/v140/orders/{order_id}/photos/{photo_id}
Method: PUT

Request Body Parameters:

PARAMETER

DESCRIPTION

MANDATORY

EXAMPLE

transfer_to

Array containing the client order ID(s) of the order(s) to which the documents will be transferred

Yes


57076502

 

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/orders/57076503/photos/180461379

 

Request Body:

{

  "transfer_to": [

    57076502

  ]

}

 

Response:

{

    "orders": [

        {

            "id": 57076502,

            "attachments": [

                {

                    "id": 180461379,

                    "status": "success"

                }

            ]

        }

    ]

}

 

Transfer Order Photos

DescriptionThis endpoint transfers all photos associated with a specific order to another order.

The destination order must be specified in the request body using the client order ID. The transfer_to field represents the client order ID of the destination order where the photos will be transferred.

All requests must include a valid Bearer Token in the request header.

URL: /api/v140/orders/{order_id}/photos/transfer
Method: PUT

Request Body Parameters:

PARAMETER

DESCRIPTION

MANDATORY

EXAMPLE

transfer_to

Array containing the client order ID(s) of the order(s) to which the documents will be transferred

Yes


57076502

 

Success Code: 200 OK – Request Successful

Example:

URL: https://api.mbsisystems.com/api/v140/orders/57076503/photos/transfer

 

Request Body:

{

  "transfer_to": [

    57076502

  ]

}

 

Response:

{

    "orders": [

        {

            "id": 57076502,

            "attachments": [

                {

                    "id": 180461378,

                    "status": "success"

                }

            ]

        },

        {

            "id": 57076502,

            "attachments": [

                {

                    "id": 180461379,

                    "status": "fail"

                }

            ]

        },

        {

            "id": 57076502,

            "attachments": [

                {

                    "id": 180461381,

                    "status": "success"

                }

            ]

        },

        {

            "id": 57076502,

            "attachments": [

                {

                    "id": 180461382,

                    "status": "success"

                }

            ]

        }

    ]

}