System Service

Provides system configuration, health checks, and version information.

Get Supported Documents

GET /v1/system/config/supported-docs

Retrieves the list of identity documents accepted by the system for customer registration and KYC.

Response:

{
  "document_types": [
    {
      "type": "passport",
      "description": "International Passport",
      "config": {
        "has_back": false
      }
    },
    {
      "type": "dire",
      "description": "DIRE - Documento de Identidade de Residente Estrangeiro",
      "config": {
        "has_back": true
      }
    },
    {
      "type": "bi",
      "description": "BI - Bilhete de Identidade",
      "config": {
        "has_back": true
      }
    }
  ]
}

Document Config

Field	Type	Description
has_back	boolean	If true, the document has two sides and image2 is required during upload

---

Get Checklist

GET /v1/system/accountopening/checklist

Retrieves the checklist of additional documents the system accepts for KYC verification review. These items can be requested by a reviewer when a customer's KYC is pending.

Response:

{
  "object": "string",
  "items": [
    {
      "item_id": "item_1",
      "type": "proof_of_address",
      "description": "Proof of Address (utility bill, bank statement)",
      "is_mandatory": false,
      "has_validity": {
        "has_duration": true
      }
    },
    {
      "item_id": "item_2",
      "type": "proof_of_income",
      "description": "Proof of Income (salary slip, tax return)",
      "is_mandatory": false,
      "has_validity": {
        "has_duration": true
      }
    }
  ]
}

Checklist Item

Field	Type	Description
item_id	string	Unique ID (pattern: item_*)
type	string	Document type code
description	string	Human-readable description
is_mandatory	boolean	Whether this document is mandatory
has_validity.has_duration	boolean	Whether the document has an expiration date

---

Get Version

GET /v1/version

Returns system version information.

Response:

{
  "version": "1.5.0",
  "git_commit": "3aa5a56",
  "build_date": "2025-01-15T08:00:00Z",
  "go_version": "go1.24.1",
  "platform": "linux/amd64"
}

Field	Type	Description
version	string	Semantic version number
git_commit	string	Git commit hash
build_date	string	Build timestamp
go_version	string	Go compiler version
platform	string	Target platform