Create person document

POST /api/v1/PersonDocuments/create

Description

This endpoint is used to create a new person document.

Tags:
PersonDocuments

URL:
/api/v{version}/PersonDocuments/create

ApiKey:
No API key required

Content-Type:
application/json

Query Parameters:
None

Path Parameters:

• version (string, required): The API version.

Request Body:

• Type (string, required): The type of the document (e.g., 'passport', 'driver license').

• Number (string, required): The number associated with the document.

• ExpiryDate (string, required): The expiry date of the document in 'YYYY-MM-DD' format.

• ImageUrl (string, required): The URL of the image of the document.

Response:
Success, returns the created person document details.

Error Codes:

Example:

/api/v1/PersonDocuments/create

Headers

Content-Type	Value
Accept-Language

Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Accept	text/plain

Body (raw)

{
  "personId": `<uuid>`,
  "type": 9,
  "base64": `<string>`,
  "fileName": `<string>`,
  "documentNumber": `<string>`
}

Response: 200

{
  "succeeded": `<boolean>`,
  "message": `<string>`,
  "errors": [
    `<string>`,
    `<string>`
  ],
  "data": {
    "id": `<uuid>`,
    "personId": `<uuid>`,
    "type": 2,
    "path": `<string>`,
    "fileName": `<string>`,
    "documentNumber": `<string>`,
    "approved": `<boolean>`
  }
}