Skip to main content

Update person document

PUT /api/v1/PersonDocuments/update

Description​

This endpoint is used to update an existing person document.

Tags:
PersonDocuments

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

ApiKey:
No API key required

Content-Type:
application/json

Query Parameters:
None

Path Parameters:

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

Request Body:

  • Id (string, required): The ID of the document.

  • 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 updated person document details.

Error Codes:
None

Example:

/api/v1/PersonDocuments/update

Headers​

Content-TypeValue
Accept-Language

Headers​

Content-TypeValue
Content-Typeapplication/json

Headers​

Content-TypeValue
Accepttext/plain

Body (raw)​

{
  "documentId": `<uuid>`,
  "personId": `<uuid>`,
  "type": 10,
  "base64": `<string>`,
  "fileName": `<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>`
  }
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request PUT \ 
 --url  /api/v1/PersonDocuments/update \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!