Skip to main content

Addressbook

Get AddressBook Item Information

GET/api/Addressbook/Info

Create Request

curl -H "Authorization: Bearer YOUR_API_KEY" 
-H "x-api-version: 1.0" "https://api.addressbook.com/v1/api/Addressbook/Info?value=johndoe"

Endpoint: Get Information about an AddressBook Item

  • URL: /api/Addressbook/Info
  • Method: GET
  • Description: Retrieve information about an AddressBook item by providing a username, email, or mobile number.
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.

Try It Out

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

Responses

  • 200 Success The request was successful, and the information about the AddressBook item is returned.
  • 400 Bad Request The request could not be understood or was missing required parameters.
  • 401 Unauthorized Authentication failed or the user does not have permission for the requested operation.
  • 500 Server Error An error occurred on the server.

Get Active User Count in Address Book

GET/api/Addressbook/Count

Create Request

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

Endpoint: Get Contact Count

  • URL: /api/Addressbook/Count
  • Method: GET
  • Description: Retrieve the count of AddressBook contacts based on a specific contact ID.
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.

Try It Out

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

Responses

  • 200 Success The request was successful, and the information about the AddressBook item is returned.
  • 400 Bad Request The request could not be understood or was missing required parameters.
  • 401 Unauthorized Authentication failed or the user does not have permission for the requested operation.
  • 500 Server Error An error occurred on the server.

Set User KYC Compliant

PUT/api/Addressbook/SetUserKYCCompliant/{contactId}

Create Request

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

Endpoint: Set User KYC Compliant

  • URL: /api/Addressbook/SetUserKYCCompliant/{contactId}
  • Method: PUT
  • Description: Update the KYC compliance status of a specific user in the address book.
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.

Try It Out

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

Responses

  • 200 Success The request was successful, and the information about the AddressBook item is returned.
  • 400 Bad Request The request could not be understood or was missing required parameters.
  • 401 Unauthorized Authentication failed or the user does not have permission for the requested operation.
  • 500 Server Error An error occurred on the server.

Rename Contact in Address Book

PUT/api/Addressbook/RenameUser

Create Request

curl -X 'PUT' \
  'https://wallet.xprizo.com/api/Addressbook/RenameUser' \
  -H 'accept: */*' \
  -H 'x-api-version: 1' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
  "id": 123,
  "description": "New Contact Name"
}'

Endpoint: Rename Contact

  • URL: /api/Addressbook/RenameUser
  • Method: PUT
  • Description: Rename a contact in the address book.
Parameter Description
Header

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

Try It Out

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"
}'

Responses

  • 200 Success The request was successful, and the information about the AddressBook item is returned.
  • 400 Bad Request The request could not be understood or was missing required parameters.
  • 401 Unauthorized Authentication failed or the user does not have permission for the requested operation.
  • 500 Server Error An error occurred on the server.

Disable Contact in Address Book

DELETE/api/Addressbook/Disable/{contactId}

Create Request

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

Endpoint: Disable Contact

  • URL: /api/Addressbook/Disable/{contactId}
  • Method: DELETE
  • Description: Disable a contact in the address book.
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.

Try It Out

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

Responses

  • 200 Success The request was successful, and the information about the AddressBook item is returned.
  • 400 Bad Request The request could not be understood or was missing required parameters.
  • 401 Unauthorized Authentication failed or the user does not have permission for the requested operation.
  • 500 Server Error An error occurred on the server.

Enable Contact in Address Book

DELETE/api/Addressbook/Enable/{contactId}

Create Request

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

Endpoint: Enable Contact

  • URL: /api/Addressbook/Enable/{contactId}
  • Method: DELETE
  • Description: Enable a previously disabled contact in the address book.
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.

Try It Out

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

Responses

  • 200 Success The request was successful, and the information about the AddressBook item is returned.
  • 400 Bad Request The request could not be understood or was missing required parameters.
  • 401 Unauthorized Authentication failed or the user does not have permission for the requested operation.
  • 500 Server Error An error occurred on the server.

Add Contact to Address Book

POST/api/Addressbook/Add

Create Request

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

Endpoint: Add Contact

  • URL: /api/Addressbook/Add
Method: POST Description: Add a new contact to the address book.
Parameter
Description Header

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

Try It Out

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"
}'

Responses

  • 200 Success The request was successful, and the information about the AddressBook item is returned.
400 Bad Request The request could not be understood or was missing required parameters. 401 Unauthorized Authentication failed or the user does not have permission for the requested operation. 500 Server Error An error occurred on the server.

Validate a User Using Rules

POST/api/Addressbook/ValidateUser

Create Request

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

Endpoint: Validate User

  • URL: /api/Addressbook/ValidateUser
Method: POST Description: Validate a user using specified rules.

Endpoint: Set User KYC Compliant

  • URL: /api/Addressbook/SetUserKYCCompliant/{contactId}
Method: PUT Description: Update the KYC compliance status of a specific user in the address book.
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.

Try It Out

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"
}'

Responses

  • 200 Success The request was successful, and the information about the AddressBook item is returned.
400 Bad Request The request could not be understood or was missing required parameters. 401 Unauthorized Authentication failed or the user does not have permission for the requested operation. 500 Server Error An error occurred on the server.

Delete an Address Book Contact

DELETE/api/Addressbook/Delete/{contactId}

Create Request

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

Endpoint: Delete Address Book Contact

  • URL: /api/Addressbook/Delete/{contactId}
Method: DELETE Description: Delete a specific contact from the address book.
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.

Try It Out

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

Responses

  • 200 Success The request was successful, and the information about the AddressBook item is returned.
400 Bad Request The request could not be understood or was missing required parameters. 401 Unauthorized Authentication failed or the user does not have permission for the requested operation. 500 Server Error An error occurred on the server.