Get one identity document with his UUID

GET 
/sint/id_doc/:uuid

Get one identity document with his UUID

Request

Path Parameters

uuid stringrequired

The UUID of the identity document you want to get

Responses

200

Return a identity document

application/json

Schema

Schema

UUID stringrequired

$UUID

TypePiece integernullable

TypePieceID

Number stringnullable

Number

Validity object nullable

Validity

oneOf

MOD1

string

MOD2

string

OwnerUUID stringnullable

OwnerUUID

algoregDocumentId stringnullable

AlgoregDocumentId

typePerLanguage string[]

Default value: ``

TypePieceIdentie

selfUpload booleannullable

The document is uploaded by user

Document object nullable

AlgoregDocument

oneOf

AlgoregDocumentDto

base64Doc stringnullable

Base64 document to upload

Example (from schema)

{
  "UUID": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
  "TypePiece": "1",
  "Number": "X4RTBPFW4",
  "Validity": "2024-11-28T17:04:27.572Z",
  "OwnerUUID": "4895ae38-a3fa-4ace-bdef-cc31fe5526a0",
  "algoregDocumentId": "0a6e0a85-16f4-4b59-8adb-431fa37af8a1",
  "typePerLanguage": "['fr'=>Titre de s├®jour,'en'=>'Residence permis']",
  "selfUpload": "true",
  "Document": {}
}

401

Unauthorized

application/json

Schema

Schema

code integer
message string

Example (from schema)

{
  "code": "401",
  "message": "JWT Token not found"
}

4XX|5XX

An error occured

application/json

Schema

Schema

success boolean
code integer
internal_code integer
message string

Example (from schema)

{
  "success": "false",
  "code": "400",
  "internal_code": "3001",
  "message": "Incorect data"
}

Loading...