Update Identity

Description

Update the settings of a single Identity owned by your account.

Request

HTTP Method: PATCH

URI Path: /v3/identities/

URI Query Parameters:

Name	Type	Is Required?	Description
id	string	Yes	Unique ID number allocated to this Identity.

Attributes

PersonalBusiness

Name	Type	Is Required?	Description
first_name	string	Optional	First name of the personal identity.
last_name	string	Optional	Last name of the personal identity.
phone_number	string	Optional	Phone number of the personal identity.
personal_tax_id	string	Optional	Personal tax ID of the personal identity.
birth_date	Date&Time	Optional	Birth date of the personal identity.
id_number	string	Optional	ID number of the personal identity.
description	string	Optional	Description of the personal identity.
external_reference_id	string	Optional	Identifier for identity in external system
contact_email	string	Optional	Contact email address of identity.

Examples

Simple Resource Patch

http

PATCH /v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

{
  "data": {
    "id": "46e129f1-deaa-44db-8915-2646de4d4c70",
    "type": "identities",
    "attributes": {
      "birth_date": "2000-01-01",
      "phone_number": "35319015266",
      "last_name": "Smith",
      "contact_email": "support@didww.com",
      "vat_id": null,
      "id_number": "0000000000",
      "description": "string",
      "personal_tax_id": "string"
    }
  }
}

curl

curl -i -X PATCH https://api.didww.com/v3/identities/46e129f1-deaa-44db-8915-2646de4d4c70 -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"birth_date": "2000-01-01", "contact_email": "support@didww.com", "description": "string", "id_number": "0000000000", "last_name": "Smith", "personal_tax_id": "string", "phone_number": "35319015266", "vat_id": null}, "id": "46e129f1-deaa-44db-8915-2646de4d4c70", "type": "identities"}}'

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c",
    "type": "identities",
    "attributes": {
      "first_name": "Jane",
      "last_name": "Smith",
      "phone_number": "35319015266",
      "id_number": "0000000000",
      "birth_date": "2000-01-01",
      "company_name": "string",
      "company_reg_number": null,
      "vat_id": null,
      "description": "string",
      "personal_tax_id": "string",
      "identity_type": "Personal",
      "created_at": "2020-09-14T07:29:41.393Z",
      "contact_email": "support@didww.com"
    },
    "relationships": {
      "country": {
        "links": {
          "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/country",
          "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/country"
        }
      },
      "proofs": {
        "links": {
          "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/proofs",
          "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/proofs"
        }
      },
      "addresses": {
        "links": {
          "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/addresses",
          "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/addresses"
        }
      },
      "permanent_documents": {
        "links": {
          "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/permanent_documents",
          "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/permanent_documents"
        }
      }
    }
  },
  "meta": {
    "api_version": "2021-04-19"
  }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized