# 7. Query by Tax Number

## **Identify Wallet Record by Tax Number**

<mark style="color:green;">`GET`</mark> `{{WalletUrl}}/api/v1/walletowner/by/taxnumber?TaxNumber=5049155355`

{% 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 API service requests.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>It is the public client key used to specify which client the API call is coming from.</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>TaxNumber</td><td>The tax number information of the wallet owner you want to query.</td></tr></tbody></table>

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

```json
{
    "Value": {
        "Id": "b5708099-be62-4d34-af06-27132082eb78",
        "MaskedFullname": "y***t",
        "Email": "Brice57@gmail.com",
        "PhoneNumber": "+9052323221594",
        "MaskedTaxNumber": "50*******5",
        "MaskedIdentityNumber": null,
        "OwnerType": "Corporate",
        "CompanyName": "Prosacco - McCullough",
        "Address": "address",
        "Country": "country",
        "City": "city",
        "DateOfBirth": "2030-10-15",
        "MerchantId": 2071,
        "CreatedAt": "2025-04-24T09:00:55.692674Z",
        "UpdatedAt": null,
        "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>Yapılan API çağrısının başarısız olup olmadığını belirten değerdir. (true/false)</td></tr><tr><td>IsSuccess</td><td>bool</td><td>Yapılan API çağrısının başarılı olup olmadığını belirten değerdir. (true/false)</td></tr><tr><td>Errors</td><td>Array</td><td>Servis çağrısı sırasında oluşan hata mesajlarını ve detaylarını içeren alandır.</td></tr><tr><td>Value</td><td>Array&#x3C;Items></td><td>Başarılı API çağrısında dönen asıl veri kümesini temsil eder.</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 defined in the system.</td></tr><tr><td>MaskedFullname</td><td>string</td><td>It is the information 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 number 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 information where the user's identity number is displayed in a masked (hidden) format.</td></tr><tr><td>OwnerType</td><td>string</td><td>It specifies the type of the wallet owner (indicating whether they are an individual user or a corporate entity).</td></tr><tr><td>CompanyName</td><td>string</td><td>If the wallet owner is corporate, it displays the registered company name.</td></tr><tr><td>Address</td><td>string</td><td>It is the wallet owner's registered full address.</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 merchant ID number associated with the relevant user.</td></tr><tr><td>CreatedAt</td><td>DateTime</td><td>It is the date and time when the record was created in the system.</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>It is the date and time when the record was last updated.</td></tr><tr><td>Wallets</td><td>List</td><td>It is the field containing the list of wallet information associated with the user.</td></tr></tbody></table>
