Create Identity

Description

Create single Identity owned by your account.

Note

By defining a certain id_number, you may reject or approve your address_verification task, please refer for more information here

Request

HTTP Method: POST

URI Path: /v3/identities

Includes:

Value	Description
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:

PersonalBusiness

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	Optional	Personal tax ID of the personal identity.
birth_date	string	Optional	Birth date of the personal identity in ISO 8601 format.
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.
identity_type	string	Yes	Type of Identity. Write “Personal” to create a personal identity.
contact_email	string	Optional	Contact email address of identity.

Request Body Object Relationships:

Title	Type	Description
countries	Countries	Specifies the country for identity.

Examples

Create Personal IdentityCreate Personal Identity with CountryCreate Business Identity

http

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

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"}}'

response

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://api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/country",
          "related": "https://api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/country"
        }
      },
      "proofs": {
        "links": {
          "self": "https://api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/proofs",
          "related": "https://api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/proofs"
        }
      },
      "addresses": {
        "links": {
          "self": "https://api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/addresses",
          "related": "https://api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/addresses"
        }
      },
      "permanent_documents": {
        "links": {
          "self": "https://api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/relationships/permanent_documents",
          "related": "https://api.didww.com/v3/identities/39623bf9-381f-4da6-ab29-2d3eb8783d81/permanent_documents"
        }
      }
    }
  },
  "meta": {
    "api_version": "2021-12-15"
  }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized