Document Operations

Introduction

This section covers how to upload, list, retrieve, and delete documents associated with a virtual IBAN account.

Use the the folowing endpoints when you need to:

upload and documents associated with a customer account
review which documents have already been submitted
retrieve details for a specific document
remove a document that was uploaded incorrectly or is no longer needed

Upload virtual IBAN document

post

/api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents

Upload virtual IBAN document

Authorizations

AuthorizationstringRequired

Authentication using a Bearer token.

Path parameters

customer_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

account_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

Body

Data required to upload a document to a virtual account.

typestring · enumRequired

Document type

Example: passportPossible values:

descriptionstringOptional

Description

Example: passport of myself

file_namestringRequired

Original filename

Example: passport.pdf

Responses

200

No content

400

Unprocessable.

application/json

401

Unauthorized.

application/json

404

Virtual IBAN not found.

422

Unprocessable.

application/json

post/api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents

POST /api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "type": "passport",
  "description": "passport of myself",
  "file_name": "passport.pdf",
  "attachment": {
    "content": "base64_content",
    "page_type": null
  }
}

No content

Get Documents List

get

/api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents

Get a paginated list of documents associated with the given customer UUID and account ID.

Authorizations

AuthorizationstringRequired

Authentication using a Bearer token.

Path parameters

customer_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

account_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

Query parameters

typestring · enumOptional

Optional document type filter.

Possible values:

filenamestringOptional

Optional document filename filter.

per_pageinteger · min: 1 · max: 100Optional

Number of items to return per page in a paginated response.

Default: 15

pageinteger · min: 1Optional

The current page number for paginated results.

Default: 1

sortstring · enumOptional

Field to sort the documents list by.

Default: created_atPossible values:

directionstring · enumOptional

Sort direction for the message list.

Default: descPossible values:

Responses

200

Successful retrieval of documents.

application/json

401

Unauthorized.

application/json

404

Document not found.

422

Unprocessable.

application/json

get/api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents

GET /api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "type": "identity_card",
    "file_name": "id_myself.pdf",
    "description": "my id from 2026",
    "page_type": "front",
    "created_at": "2025-01-15T10:30:00Z",
    "status": "pending"
  }
]

Get Document Details

get

/api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents/{document_uuid}

Retrieves the details of a specific document by its UUID.

Authorizations

AuthorizationstringRequired

Authentication using a Bearer token.

Path parameters

customer_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

account_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

document_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

Responses

200

Successful retrieval of document details.

application/json

uuidstring · uuidOptional

The unique identifier (UUID) of the document.

typestring · enumOptional

The type of the document.

Example: identity_cardPossible values:

file_namestringOptional

The original filename of the uploaded document.

Example: id_myself.pdf

descriptionstringOptional

Description of the document.

Example: my id from 2026

page_typestring · enum · nullableOptional

Page side of the document (available for identity_card and drivers_license)

Example: frontPossible values:

created_atstring · date-timeOptional

The timestamp when the document was created.

Example: 2025-01-15T10:30:00Z

statusstring · enumOptional

Status of the document

Example: pendingPossible values:

401

Unauthorized.

application/json

404

Document not found.

422

Unprocessable.

application/json

get/api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents/{document_uuid}

GET /api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents/{document_uuid} HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "type": "identity_card",
  "file_name": "id_myself.pdf",
  "description": "my id from 2026",
  "page_type": "front",
  "created_at": "2025-01-15T10:30:00Z",
  "status": "pending"
}

Delete Document

delete

/api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents/{document_uuid}

Deletes a specific document by its UUID.

Authorizations

AuthorizationstringRequired

Authentication using a Bearer token.

Path parameters

customer_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

account_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

document_uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

Responses

204

Document successfully deleted.

No content

401

Unauthorized.

application/json

404

Document not found.

422

Unprocessable.

application/json

delete/api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents/{document_uuid}

DELETE /api/v1/customers/{customer_uuid}/accounts/{account_uuid}/documents/{document_uuid} HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

PreviousVirtual IBANs NextVirtual IBAN balance reporting

Last updated 4 months ago

Was this helpful?