Get Identity

Description

Returns a single Identity in the account.

Request

HTTP Method: GET

URI Path: /v3/identities/

URI Query Parameters:

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of the Identity.

Examples

http

GET /v3/identities/0083c7f2-b030-491f-91b3-54597967ca38 HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -i -X GET https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38 -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

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

{
    "data": {
        "id": "0083c7f2-b030-491f-91b3-54597967ca38",
        "type": "identities",
        "attributes": {
            "first_name": "Jane",
            "last_name": "Smith",
            "phone_number": "1276813663",
            "id_number": "",
            "birth_date": null,
            "company_name": null,
            "company_reg_number": null,
            "vat_id": null,
            "description": null,
            "personal_tax_id": null,
            "identity_type": "Personal"
        },
        "relationships": {
            "country": {
                "links": {
                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/country",
                    "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/country"
                }
            },
            "proofs": {
                "links": {
                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/proofs",
                    "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/proofs"
                }
            },
            "addresses": {
                "links": {
                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/addresses",
                    "related": "https://sandbox-api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/addresses"
                }
            },
            "permanent_documents": {
                "links": {
                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/permanent_documents",
                    "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/permanent_documents"
                }
            }
        }
    },
    "meta": {
        "api_version": "2022-05-10"
    }
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized