Ashley DeBon: /* Successful Response (200) */

2026-07-21T15:09:25Z

‎Successful Response (200)

Ashley DeBon: /* Render Image */

2026-07-21T15:08:55Z

‎Render Image

Ashley DeBon: Created page with "== Render Image == === Base URL === https://apimobile.callproof.com === Endpoint === /api/image/{document_type}/{id} === Purpose === Renders a stored image by encrypted ID...."

2026-07-21T15:08:42Z

Created page with "== Render Image == === Base URL === https://apimobile.callproof.com === Endpoint === /api/image/{document_type}/{id} === Purpose === Renders a stored image by encrypted ID...."

New page

== Render Image ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/image/{document_type}/{id}

=== Purpose ===
Renders a stored image by encrypted ID. For business cards (`document_type` = <code>business_card</code>), returns a resized front or back card image as a JPEG response.

=== HTTP Method ===
GET

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || No || Not required for this endpoint
|}

=== Security ===
* '''No''' – This route is public (outside the authenticated API middleware group). Access depends on knowing the encrypted image ID.

=== Parameters ===

==== Path Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| document_type || string || Yes || Image category. Supported value for rendering: <code>business_card</code>
|-
| id || string || Yes || Encrypted image/record identifier (Laravel-encrypted business card ID)
|}

==== Query Parameters ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| type || string || Conditional || Required for business cards. Use <code>frontImage</code> for the front side or <code>backImage</code> for the back side
|}

==== Request Body ====
None.

=== Successful Response (200) ===
Returns the image binary (JPEG), not a JSON body.

{| class="wikitable"
! Field !! Type !! Description
|-
| Content-Type || header || Typically <code>image/jpeg</code>
|-
| Body || binary || Resized business card image (max width 900, max height 500)
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 404 || Not Found – invalid/encrypted ID, missing business card, or image could not be rendered
|}

* '''404''' – Decryption failed, business card not found, or image path unavailable.

← Older revision		Revision as of 15:08, 21 July 2026
Line 1:		Line 1:
−	== Render Image ==	+	== [[Mobile_API]] »Render Image ==

	=== Base URL ===		=== Base URL ===

@@ Line 43: / Line 43: @@
 ==== Request Body ====
 None.
 === Successful Response (200) ===

Render Business Image - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: /* Render Image */

Ashley DeBon: Created page with "== Render Image == === Base URL === https://apimobile.callproof.com === Endpoint === /api/image/{document_type}/{id} === Purpose === Renders a stored image by encrypted ID...."