Addressbook

Get AddressBook Item Information

Introduction

The GET /api/Addressbook/Info endpoint allows you to retrieve information about a specific item in the address book. You can search using a username, email, or mobile number.

Create Request

curl -X 'GET' \
  'https://wallet.xprizo.com/api/Addressbook/Info?value=John%20Doe' \
  -H 'accept: text/plain' \
  -H 'x-api-version: 1'

Endpoint: Get Information about an AddressBook Item

Parameter Description
Query (string, required): Enter the username, email, or mobile number of the contact you are searching for.
Header (string, required): Specify the API version.

Responses

Response (200 Success)

The request was successful, and the information about the AddressBook item is returned.

{
  "id": 0,
  "description": "string"
}

Errors

Get Active User Count in Address Book

Introduction

The GET /api/Addressbook/Count endpoint allows you to retrieve the number of active users in the address book.

Create Request

curl -X 'GET' \
  'https://wallet.xprizo.com/api/Addressbook/Count?contactId=2131' \
  -H 'accept: text/plain' \
  -H 'x-api-version: 1'

Endpoint: Get Contact Count

Parameter Description
Query contactId (integer, required): The ID of the contact for which you want to get the count.
Header

x-api-version (string, required): Specify the API version.

Responses

Response (200 Success)

The request was successful, and the information about the AddressBook item is returned.

Errors

Set User KYC Compliant

Introduction

The SetUserKYCCompliant API endpoint allows you to update the KYC (Know Your Customer) compliance status of a user in the address book. This endpoint requires proper authentication and versioning headers.

Create Request

curl -X 'PUT' \
  'https://wallet.xprizo.com/api/Addressbook/SetUserKYCCompliant/123?value=true' \
  -H 'accept: */*' \
  -H 'x-api-version: 1'

Endpoint: Set User KYC Compliant

Parameter Description
Path contactId (integer, required): The ID of the contact whose KYC compliance status is being updated.
Query contactId (integer, required): The ID of the contact for which you want to get the count.
Header

x-api-version (string, required): Specify the API version.

Responses

Response (200 Success)

The request was successful, and the information about the AddressBook item is returned.

Errors

Rename Contact in Address Book

Introduction

The PUT /api/Addressbook/RenameUser endpoint allows you to rename a contact in the address book.

Create Request

curl -X 'PUT' \
  'https://wallet.xprizo.com/api/Addressbook/RenameUser' \
  -H 'accept: */*' \
  -H 'x-api-version: 1' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": 0,
  "description": "string"
}'

Endpoint: Rename Contact

Parameter Description
Header

x-api-version (string, required): Specify the API version.

Responses

Response (200 Success)

The request was successful, and the information about the AddressBook item is returned.

Errors

Disable Contact in Address Book

Introduction

The DELETE /api/Addressbook/Disable/{contactId} endpoint allows you to disable a contact in the address book.

Create Request

curl -X 'DELETE' \
  'https://wallet.xprizo.com/api/Addressbook/Disable/123' \
  -H 'accept: */*' \
  -H 'x-api-version: 1'

Endpoint: Disable Contact

Parameter Description
Path contactId (integer, required): The ID of the contact whose KYC compliance status is being updated.
Header

x-api-version (string, required): Specify the API version.

Responses

Response (200 Success)

The request was successful, and the information about the AddressBook item is returned.

Errors

Enable Contact in Address Book

Introduction

The DELETE /api/Addressbook/Enable/{contactId} endpoint allows you to enable a previously disabled contact in the address book.

Create Request

curl -X 'DELETE' \
  'https://wallet.xprizo.com/api/Addressbook/Enable/123' \
  -H 'accept: */*' \
  -H 'x-api-version: 1'

Endpoint: Enable Contact

Parameter Description
Path contactId (integer, required): The ID of the contact whose KYC compliance status is being updated.
Header

x-api-version (string, required): Specify the API version.

Responses

Response (200 Success)

The request was successful, and the information about the AddressBook item is returned.

Errors

Add Contact to Address Book

Introduction

The POST /api/Addressbook/Add endpoint allows you to add a new contact to the address book. The contact information can be a phone number, email, or a name.

Create Request

curl -X 'POST' \
  'https://wallet.xprizo.com/api/Addressbook/Add' \
  -H 'accept: */*' \
  -H 'x-api-version: 1' \
  -H 'Content-Type: application/json' \
  -d '{
  "value": "string"
}'

Endpoint: Add Contact

Parameter Description
Header

x-api-version (string, required): Specify the API version.

Responses

Response (200 Success)

The request was successful, and the information about the AddressBook item is returned.

Errors

Validate a User Using Rules

Introduction

The POST /api/Addressbook/ValidateUser endpoint allows you to validate a user based on specific rules. The validation can be performed using a contact name, which can be a phone number, an email address, or a name.

Create Request

curl -X 'POST' \
  'https://wallet.xprizo.com/api/Addressbook/ValidateUser?ruleName=test' \
  -H 'accept: text/plain' \
  -H 'x-api-version: 1' \
  -H 'Content-Type: application/json' \
  -d '{
  "value": "string"
}'

Endpoint: Validate User

Endpoint: Set User KYC Compliant

Parameter Description
Request value (string, required): The contact information to be validated. This can be a phone number, email, or name.
Query contactId (integer, required): The ID of the contact for which you want to get the count.
Header

x-api-version (string, required): Specify the API version.

Responses

Response (200 Success)

The request was successful, and the information about the AddressBook item is returned.

{
  "id": 0,
  "description": "string"
}

Errors

Delete an Address Book Contact

Introduction

The DELETE /api/Addressbook/Delete/{contactId} endpoint allows you to delete a specific contact from the address book.

Create Request

curl -X 'DELETE' \
  'https://wallet.xprizo.com/api/Addressbook/Delete/123' \
  -H 'accept: */*' \
  -H 'x-api-version: 1'

Endpoint: Delete Address Book Contact

Parameter Description
Path contactId (integer, required): The unique ID of the contact to be deleted.
Header

x-api-version (string, required): Specify the API version.

Responses


Revision #17
Created 24 May 2024 09:11:41
Updated 3 June 2024 06:05:29