CorebanqCorebanq Developer Docs
Uploadsv1Customer Documents

Get customer file by type

Get customer files of a specific type

GET/v1/uploads/customer/{customer_id}/file/type/{file_type}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

customer_id*string
file_type*string

Document type code from uploads.documents in uploads.yaml. Valid values are defined at deploy time (not a fixed API enum). Examples include avatar, bylaws, license, articles_of_association, tariffs, customer_agreement, and other. The API returns 400 with allowed_types when the code is not configured.

Query Parameters

is_signed?boolean
is_approved?boolean

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/uploads/customer/497f6eca-6276-4993-bfeb-53cbbbba6f08/file/type/bylaws"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "file_name": "string",
  "document_type": "bylaws",
  "approval_status": "pending",
  "approval_needed": 0.1,
  "approval_made": 0.1,
  "signature_status": "pending",
  "signature_needed": 0.1,
  "signature_made": 0.1,
  "content_length": 0,
  "file_extension": "string",
  "active": true,
  "metadata": {},
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4"
}

{
  "code": "uploads.record_not_found",
  "message": "Record not found"
}