# 6. Query by Identity

## **Identify Wallet Record by Identity**

<mark style="color:green;">`GET`</mark> `{{WalletUrl}}/api/v1/walletowner/by/identity?Identity=68567422314`&#x20;

{% hint style="info" %}
**Note:** Before calling this service, you must include the **apikeypublic** and **apiclientpublic** parameters in the Header section.

[<mark style="color:green;">**WalletAPI Address**</mark>](https://developer.paywall.one/payment-orchestration-integration-document/environment)
{% endhint %}

**The parameters that must be sent to the service are as follows:**

<table><thead><tr><th width="162">Parameter</th><th width="79">Type</th><th width="107">Required</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>It is the public key used for authentication in service calls.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>It is the public key used to specify the identity of the API client.</td></tr></tbody></table>

**The (QueryString) parameters that must be sent to the service are as follows:**

<table><thead><tr><th width="162">Parameter</th><th width="403">Description</th></tr></thead><tbody><tr><td>Identity</td><td>The identity information of the wallet owner you want to query.</td></tr></tbody></table>

{% tabs %}
{% tab title="Service Request - JSON" %}
{% code lineNumbers="true" %}

```json
{
    "Value": {
        "Id": "9ef565a2-5987-4da4-8b0e-f0b392196e7e",
        "MaskedFullname": "y***t",
        "Email": "Makenzie.Bins68@yahoo.com",
        "PhoneNumber": "+905343664456",
        "MaskedTaxNumber": "",
        "MaskedIdentityNumber": "685******14",
        "OwnerType": "Individual",
        "CompanyName": "Schuster - Labadie",
        "Address": "57152 Koepp Prairie",
        "Country": "Senegal",
        "City": "Volkmanberg",
        "DateOfBirth": "2001-03-03",
        "MerchantId": 2071,
        "CreatedAt": "2025-04-22T12:40:20.724936Z",
        "UpdatedAt": "2025-04-22T12:41:09.156117Z",
        "Wallets": []
    },
    "Errors": [],
    "IsSuccess": true,
    "IsFailure": false
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

## **Service Response**

<table><thead><tr><th width="192">Parameter</th><th width="147.89192708333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>IsFailure</td><td>bool</td><td>Indicates whether the related service call has failed or not. (true/false)</td></tr><tr><td>IsSuccess</td><td>bool</td><td>Indicates whether the related service call was successful or not. (true/false)</td></tr><tr><td>Errors</td><td>Array</td><td>The area where error messages occurring during the service call are listed.</td></tr><tr><td>Value</td><td>Array&#x3C;Items></td><td>The area representing the main data object returned by the service.</td></tr></tbody></table>

## **Service Response** (Value)

<table><thead><tr><th>Parameter</th><th>Type</th><th width="348.94140625">Description</th></tr></thead><tbody><tr><td>Id</td><td>Guid</td><td>It is the unique identifier of the entity recorded in the system.</td></tr><tr><td>MaskedFullname</td><td>string</td><td>It is the field where the user's full name is displayed in a masked (hidden) format.</td></tr><tr><td>Email</td><td>string</td><td>It is the user's registered email address.</td></tr><tr><td>PhoneNumber</td><td>string</td><td>It is the user's registered phone number.</td></tr><tr><td>MaskedTaxNumber</td><td>string</td><td>It is the field where the user's tax number is displayed in a masked (hidden) format.</td></tr><tr><td>MaskedIdentityNumber</td><td>string</td><td>It is the field where the user's identity number is displayed in a masked (hidden) format.</td></tr><tr><td>OwnerType</td><td>string</td><td>It is the field that specifies whether the wallet owner is an individual or a corporate entity.</td></tr><tr><td>CompanyName</td><td>string</td><td>It is the registered company name of the wallet owner (if applicable).</td></tr><tr><td>Address</td><td>string</td><td>It is the field containing the registered address information of the wallet owner.</td></tr><tr><td>Country</td><td>string</td><td>It is the country information where the wallet owner is registered.</td></tr><tr><td>City</td><td>string</td><td>It is the city information where the wallet owner is registered.</td></tr><tr><td>DateOfBirth</td><td>Date</td><td>It is the date of birth of the wallet owner.</td></tr><tr><td>MerchantId</td><td>int</td><td>It is the date of birth of the wallet owner.</td></tr><tr><td>CreatedAt</td><td>DateTime</td><td>Indicates the creation time of the record.</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>Indicates the last updated time of the record.</td></tr><tr><td>Wallets</td><td>List</td><td>It is the field representing the list of wallets associated with the user.</td></tr></tbody></table>