Create Identity

Description

Create single Identity owned by your account.

Request

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:

Personal

Business

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	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
identity_type	string	Yes	Type of Identity. Write “Personal” to create a personal identity.

Name	Type	Is Required?	Description
company_name	string	Yes	Company name of the business identity.
company_reg_number	string	Optional	Company registration number of the business identity.
vat_id	string	Optional	Company VAT ID of the business identity.
first_name	string	Yes	Company’s representative First name of the business identity.
last_name	string	Yes	Company’s representative Last name of the business identity.
phone_number	string	Yes	Company’s representative Phone number of the business identity.
personal_tax_id	string	Optional	Company’s representative Tax ID of the business identity.
birth_date	Date&Time	Optional	Company’s representative Birth date of the business identity.
id_number	string	Optional	Company’s representative ID number of the business identity.
description	string	Optional	Company’s representative description of the business identity.
external_reference_id	string	Optional	Identifier for identity in external system
identity_type	string	Yes	Identity type. Write “Business” to create a business identity.

Request Body Object Relationships:

Title	Type	Description
countries	Countries	Specifies the country for identity.

Examples

Create Personal Identity

Create 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",
      "id_number": "string",
      "description": "string",
      "personal_tax_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": {"description": "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://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"
    }
}

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",
      "id_number": "string",
      "birth_date": "string",
      "company_name": "string",
      "company_reg_number": "string",
      "vat_id": "string",
      "description": "string",
      "personal_tax_id": "string",
      "identity_type": "Business"
    },
    "relationships": {
      "country": {
        "data": {
          "id": "6d0effab-3fe3-4e07-acc6-1d3ddc717ebc",
          "type": "countries"
        }
      }
    }
  }
}

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": "string", "company_name": "string", "company_reg_number": "string", "description": "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"}}'

response

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://sandbox-api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/country",
                    "related": "https://sandbox-api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/country"
                }
            },
            "proofs": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/proofs",
                    "related": "https://sandbox-api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/proofs"
                }
            },
            "addresses": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/addresses",
                    "related": "https://sandbox-api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/addresses"
                }
            },
            "permanent_documents": {
                "links": {
                    "self": "https://sandbox-api.didww.com/v3/identities/fb7f3f67-014c-496b-b918-f874f2689a40/relationships/permanent_documents",
                    "related": "https://sandbox-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	Not Found
401	No	Unauthorized