Create Identity
Description
Create single Identity owned by your account.
Request
Includes:
Value |
Description |
---|---|
country |
|
proofs |
|
addresses |
|
addresses.country |
|
proofs.proof_type |
|
permanent_documents |
|
permanent_documents.template |
Request Body Object Attributes:
Name |
Type |
Is Required? |
Description |
---|---|---|---|
first_name |
|
Yes |
First name of the personal identity. |
last_name |
|
Yes |
Last name of the personal identity. |
phone_number |
|
Yes |
Phone number of the personal identity. |
personal_tax_id |
|
No |
Personal tax ID of the personal identity. |
birth_date |
|
No |
Birth date of the personal identity in ISO 8601 format. |
id_number |
|
No |
ID number of the personal identity. |
description |
|
No |
Description of the personal identity. |
external_reference_id |
|
No |
Identifier for identity in external system |
identity_type |
|
Yes |
Type of Identity. Write “Personal” to create a personal identity. |
Name |
Type |
Is Required? |
Description |
---|---|---|---|
company_name |
|
Yes |
Company name of the business identity. |
company_reg_number |
|
No |
Company registration number of the business identity. |
vat_id |
|
No |
Company VAT ID of the business identity. |
first_name |
|
Yes |
Company’s representative First name of the business identity. |
last_name |
|
Yes |
Company’s representative Last name of the business identity. |
phone_number |
|
Yes |
Company’s representative Phone number of the business identity. |
personal_tax_id |
|
No |
Company’s representative Tax ID of the business identity. |
birth_date |
|
No |
Company’s representative Birth date of the business identity in ISO 8601 format. |
id_number |
|
No |
Company’s representative ID number of the business identity. |
description |
|
No |
Company’s representative description of the business identity. |
external_reference_id |
|
No |
Identifier for identity in external system |
identity_type |
|
Yes |
Identity type. Write “Business” to create a business identity. |
Request Body Object Relationships:
Title
Type
Description
countries
Specifies the country for identity.
Examples
POST /v3/identities HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
{
"data": {
"type": "identities",
"attributes": {
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"birth_date": null,
"id_number": "string",
"description": "string",
"personal_tax_id": "string",
"external_reference_id": "string",
"identity_type": "Personal"
}
}
}
curl -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, "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"}}'
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "39623bf9-381f-4da6-ab29-2d3eb8783d81",
"type": "identities",
"attributes": {
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"id_number": "string",
"birth_date": null,
"company_name": null,
"company_reg_number": null,
"vat_id": null,
"description": "string",
"personal_tax_id": "string",
"identity_type": "Personal",
"created_at": "2021-03-22T11:53:32.240Z",
"external_reference_id": null,
"verified": false
},
"relationships": {
"country": {
"links": {
"self": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/country",
"related": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/country"
}
},
"proofs": {
"links": {
"self": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/proofs",
"related": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/proofs"
}
},
"addresses": {
"links": {
"self": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/addresses",
"related": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/addresses"
}
},
"permanent_documents": {
"links": {
"self": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/permanent_documents",
"related": "https://sandbox-api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/permanent_documents"
}
}
}
},
"meta": {
"api_version": "2022-05-10"
}
}
POST /v3/identities HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
{
"data": {
"type": "identities",
"attributes": {
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"birth_date": null,
"id_number": "string",
"description": "string",
"personal_tax_id": "string",
"external_reference_id": "string",
"identity_type": "Personal"
},
"relationships": {
"country": {
"data": {
"id": "c8647639-fc9c-47b2-acec-7c9e14465c25",
"type": "countries"
}
}
}
}
}
curl -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, "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"}, "relationships": {"country": {"data": {"id": "c8647639-fc9c-47b2-acec-7c9e14465c25", "type": "countries"}}}, "type": "identities"}}'
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "874390d1-ea6f-47c0-8d30-c9baaaeebdd9",
"type": "identities",
"attributes": {
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"id_number": "string",
"birth_date": null,
"company_name": null,
"company_reg_number": null,
"vat_id": null,
"description": "string",
"personal_tax_id": "string",
"identity_type": "Personal",
"created_at": "2023-01-31T09:23:10.406Z",
"external_reference_id": "string",
"verified": false
},
"relationships": {
"country": {
"links": {
"self": "https://api.didww.com/v3/identities/874390d1-ea6f-47c0-8d30-c9baaaeebdd9/relationships/country",
"related": "https://api.didww.com/v3/identities/874390d1-ea6f-47c0-8d30-c9baaaeebdd9/country"
}
},
"proofs": {
"links": {
"self": "https://api.didww.com/v3/identities/874390d1-ea6f-47c0-8d30-c9baaaeebdd9/relationships/proofs",
"related": "https://api.didww.com/v3/identities/874390d1-ea6f-47c0-8d30-c9baaaeebdd9/proofs"
}
},
"addresses": {
"links": {
"self": "https://api.didww.com/v3/identities/874390d1-ea6f-47c0-8d30-c9baaaeebdd9/relationships/addresses",
"related": "https://api.didww.com/v3/identities/874390d1-ea6f-47c0-8d30-c9baaaeebdd9/addresses"
}
},
"permanent_documents": {
"links": {
"self": "https://api.didww.com/v3/identities/874390d1-ea6f-47c0-8d30-c9baaaeebdd9/relationships/permanent_documents",
"related": "https://api.didww.com/v3/identities/874390d1-ea6f-47c0-8d30-c9baaaeebdd9/permanent_documents"
}
}
}
},
"meta": {
"api_version": "2022-05-10"
}
}
POST /v3/identities HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
{
"data": {
"type": "identities",
"attributes": {
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"id_number": "string",
"birth_date": "string",
"company_name": "string",
"company_reg_number": "string",
"vat_id": "string",
"description": "string",
"personal_tax_id": "string",
"external_reference_id": "string",
"identity_type": "Business"
},
"relationships": {
"country": {
"data": {
"id": "6d0effab-3fe3-4e07-acc6-1d3ddc717ebc",
"type": "countries"
}
}
}
}
}
curl -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": "string", "company_name": "string", "company_reg_number": "string", "description": "string", "external_reference_id": "string", "first_name": "string", "id_number": "string", "identity_type": "Business", "last_name": "string", "personal_tax_id": "string", "phone_number": "string", "vat_id": "string"}, "relationships": {"country": {"data": {"id": "6d0effab-3fe3-4e07-acc6-1d3ddc717ebc", "type": "countries"}}}, "type": "identities"}}'
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "fb7f3f67-014c-496b-b918-f874f2689a40",
"type": "identities",
"attributes": {
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"id_number": "string",
"birth_date": null,
"company_name": "string",
"company_reg_number": null,
"vat_id": null,
"description": "string",
"personal_tax_id": "string",
"identity_type": "Business",
"created_at": "2021-03-22T12:08:29.987Z",
"external_reference_id": null,
"verified": false
},
"relationships": {
"country": {
"links": {
"self": "https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/country",
"related": "https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/country"
}
},
"proofs": {
"links": {
"self": "https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/proofs",
"related": "https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/proofs"
}
},
"addresses": {
"links": {
"self": "https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/addresses",
"related": "https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/addresses"
}
},
"permanent_documents": {
"links": {
"self": "https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/permanent_documents",
"related": "https://api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/permanent_documents"
}
}
}
},
"meta": {
"api_version": "2022-05-10"
}
}
Other Responses
Code |
Success |
Description |
---|---|---|
404 |
No |
|
401 |
No |