Create Identity#

Create single Identity owned by your account.

Request#

HTTP Method: POST

URI Path: /v3/identities/

Includes#

Value

Description

country

Country Object

birth_country

Country Object

proofs

Proofs Object

addresses

Addresses Object

addresses.country

Country Object

proofs.proof_type

Proof Types Object

permanent_documents

Permanent Documents Object

permanent_documents.template

Supporting Document Template Object

Request Body Object Attributes#

Name

Type

Is Required?

Description

first_name

string

Yes

First name of the personal identity.

last_name

string

Yes

Last name of the personal identity.

phone_number

string

Yes

Phone number of the personal identity.

personal_tax_id

string

No

Personal tax ID of the personal identity.

birth_date

string

No

Birth date of the personal identity in ISO 8601 format.

id_number

string

No

ID number of the personal identity.

description

string

No

Description of the personal identity.

external_reference_id

string

No

Identifier for identity in external system

identity_type

string

Yes

Type of identity. Write personal to create a personal identity.

contact_email

string

No

Contact email address of identity.

Request Body Object Relationships#

Title

Type

Description

country

Country Object

Specifies the country for identity.

birth_country

Country Object

Specifies the birth country for identity. In version 2026-04-16, it is handled separately from country and is not auto-assigned.

Note

Assigning country does not automatically assign birth_country. Set birth_country explicitly when needed.

Examples#

http

 1POST /v3/identities HTTP/1.1
 2Host: api.didww.com
 3Content-Type: application/vnd.api+json
 4Accept: application/vnd.api+json
 5Api-Key: [API token]
 6
 7{
 8  "data": {
 9    "type": "identities",
10    "attributes": {
11      "first_name": "string",
12      "last_name": "string",
13      "phone_number": "string",
14      "birth_date": null,
15      "id_number": "string",
16      "description": "string",
17      "personal_tax_id": "string",
18      "external_reference_id": "string",
19      "identity_type": "personal",
20      "contact_email": "string"
21    }
22  }
23}

curl

1curl -i -X POST https://api.didww.com/v3/identities -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"birth_date": null, "contact_email": "string", "description": "string", "external_reference_id": "string", "first_name": "string", "id_number": "string", "identity_type": "personal", "last_name": "string", "personal_tax_id": "string", "phone_number": "string"}, "type": "identities"}}'

response

 1HTTP/1.1 201 Created
 2Content-Type: application/vnd.api+json
 3
 4{
 5  "data": {
 6    "id": "39623bf9-381f-4da6-ab29-2d3eb8783d81",
 7    "type": "identities",
 8    "attributes": {
 9      "first_name": "string",
10      "last_name": "string",
11      "phone_number": "string",
12      "id_number": "string",
13      "birth_date": null,
14      "company_name": null,
15      "company_reg_number": null,
16      "vat_id": null,
17      "description": "string",
18      "personal_tax_id": "string",
19      "identity_type": "personal",
20      "created_at": "2021-03-22T11:53:32.240Z",
21      "external_reference_id": null,
22      "verified": false,
23      "contact_email": "string"
24    },
25    "relationships": {
26      "country": {
27        "links": {
28          "self": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/country",
29          "related": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/country"
30        }
31      },
32      "proofs": {
33        "links": {
34          "self": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/proofs",
35          "related": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/proofs"
36        }
37      },
38      "addresses": {
39        "links": {
40          "self": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/addresses",
41          "related": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/addresses"
42        }
43      },
44      "permanent_documents": {
45        "links": {
46          "self": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/permanent_documents",
47          "related": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/permanent_documents"
48        }
49      }
50    }
51  },
52  "meta": {
53    "api_version": "2026-04-16"
54  }
55}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized