Skip to main content
GET
/
v1
/
identity
/
documents
/
idvs
/
{id}
Get government ID document
curl --request GET \
  --url https://api.beltic.com/v1/identity/documents/idvs/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "document/idv",
    "attributes": {
      "status": "pending",
      "document_type": "<string>",
      "name": {
        "first": "<string>",
        "middle": "<string>",
        "last": "<string>"
      },
      "sex": "<string>",
      "birth_date": "<string>",
      "birth_place": "<string>",
      "document_number": "<string>",
      "issue_date": "<string>",
      "expiry_date": "<string>",
      "issuing_authority": "<string>",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "subdivision": "<string>",
        "postal_code": "<string>",
        "country_code": "<string>"
      },
      "nationality": "<string>",
      "personal_number": "<string>",
      "document_class": "<string>",
      "issuing_country": "<string>",
      "place_of_issue": "<string>",
      "files": [
        {
          "id": "<string>",
          "filename": "<string>",
          "status": "pending_upload",
          "url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
          "content_type": "<string>",
          "byte_size": 123,
          "checksum": "<string>"
        }
      ],
      "front_side": {
        "id": "<string>",
        "filename": "<string>",
        "status": "pending_upload",
        "url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
        "content_type": "<string>",
        "byte_size": 123,
        "checksum": "<string>"
      },
      "back_side": {
        "id": "<string>",
        "filename": "<string>",
        "status": "pending_upload",
        "url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
        "content_type": "<string>",
        "byte_size": 123,
        "checksum": "<string>"
      },
      "portrait": {
        "id": "<string>",
        "filename": "<string>",
        "status": "pending_upload",
        "url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
        "content_type": "<string>",
        "byte_size": 123,
        "checksum": "<string>"
      },
      "signature": {
        "id": "<string>",
        "filename": "<string>",
        "status": "pending_upload",
        "url": "https://s3.amazonaws.com/...?X-Amz-Signature=...",
        "content_type": "<string>",
        "byte_size": 123,
        "checksum": "<string>"
      },
      "created_at": "<string>",
      "submitted_at": "<string>",
      "processed_at": "<string>"
    },
    "relationships": {
      "account": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        }
      },
      "session": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        }
      },
      "verification": {
        "data": {
          "type": "<string>",
          "id": "<string>"
        }
      }
    }
  }
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication. Access https://console.beltic.com/ to obtain your API key.

Path Parameters

​
id
string<uuid>
required

The unique identifier of the document

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Successfully retrieved document

​
data
object
required