--- title: "Retrieve Wallet Contact" source_url: https://docs.rapyd.net/en/retrieve-wallet-contact.html lang: en --- # Retrieve Wallet Contact Retrieve a contact for an existing Rapyd Wallet. > **Note:** > > - The code samples include successful requests (200) and bad requests (400). > > - For error messages that appear due to bad requests (400), see: > > - [General Errors](https://docs.rapyd.net/en/general-errors.md "General Errors") > - [Wallet Contact Errors](https://docs.rapyd.net/en/wallet-contact-errors.md "Wallet Contact Errors") > - [Wallet Errors](https://docs.rapyd.net/en/wallet-errors.md "Wallet Errors") > - For information about unauthorized request (401) and other authentication errors, see [Troubleshooting Authentication and Authorization Errors](https://docs.rapyd.net/en/troubleshooting-authentication-and-authorization-errors.md "Troubleshooting Authentication and Authorization Errors"). ### Parameters ### Request Path Parameters - - wallet - ID of the Rapyd Wallet that this contact is associated with. String starting with **ewallet_**. - - contact - ID of the contact. String starting with the prefix **cont_**. Required when `contact_reference_id` is not used. - - contact_reference_id - ID of the wallet contact, defined by the customer or end user. String. Must be unique and cannot start with **cont_**. Required when `contact` is not used. ### Request Header Parameters - - access_key - Unique access key provided by Rapyd for each authorized user. See [Developers](https://docs.rapyd.net/en/developers.md "Developers"). - - Content-Type - Indicates that the data appears in JSON format. Set to **application/json**. - - salt - Random string. Recommended length: 8-16 characters. - - signature - Signature calculated for each request individually. See [Request Signatures](https://docs.rapyd.net/en/request-signatures.md "Request Signatures"). - - timestamp - Timestamp for the request, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time") (seconds). ### Response Parameters - - address - Address of this contact person. Required when the client issues a card to the contact. This can be an 'address' object or the ID of an address object. For more information about the fields of the 'address' object, see [Create Address](https://docs.rapyd.net/en/create-address.md "Create Address"). - - authorized_user_details - Contains the authorized signatory information for the wallet business contact. This object is only relevant to **business** contacts and returns `null` when not applicable. - - country - The two-letter ISO 3166-1 ALPHA-2 country code of the authorized user. - - date_of_birth - Date of birth of the authorized user. Format: **YYYY-MM-DD** - - first_name - First name of the authorized user. - - last_name - Last name of the authorized user. - - business_details - Describes additional information for business entities. Required when `type` is **company**. - - address - Principal address of the business. See [Create Address](https://docs.rapyd.net/en/create-address.md "Create Address"). - - annual_revenue - Annual revenue of the business in US dollars. Maximum value: 100000000000000. Decimal. - - cnae_code - Business activity code of the business, according to the Classificação Nacional de Atividades Econômicas of Brazil. Alphanumeric string. Maximum 7 characters. - - created_at - Time of creation of the `business_details` object, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time"). - - customer_service_phone_number - Phone number for contacting the customer support service of the sub-merchant business,  in E.164 format. Relevant to Payment Facilitator (PayFac). - - entity_type - Type of business entity. One of the following: - **sole_prop** - Sole proprietorship. - **partnership** - Partnership. - **company** - Company. - **government** - Government agency. - **charity** - Charity. - **NPO** - Non-profit organization. - **association** - Unincorporated business association. - **trust** - Trust. - - establishment_date - Date that the business was established. Format: **YYYY-MM-DD**. - - id - ID of the `business_details` object. String starting with **busi_**. - - industry_category - Name of the industry that this business belongs to. Alphanumeric string with no special characters. - - industry_sub_category - Subcategory of the industry that this business belongs to. - - legal_entity_type - Type of legal entity. Alphanumeric string. - - mcc - Four-digit merchant category code (MCC) of the sub-merchant business, as defined in [ISO 18245](https://www.iso.org/standard/79450.html). Relevant to Payment Facilitator (PayFac). - - name - Business name. - - registration_number - Registration number. - - statement_descriptor - The sub-merchant name or business name.. Relevant to Payment Facilitator (PayFac). - - tax_id - The merchant’s company tax identifier. - - website_url - URL of the sub-merchant business website. Relevant to Payment Facilitator (PayFac). - - compliance_profile - Indicates the degree to which this contact can use the wallet. One of the following: - **1** - All transactions are allowed. - **0** - The wallet is limited, and the contact must complete the identity verification process. - **-1** - The wallet is restricted and cannot be used for any transactions. - - contact_reference_id - ID of a wallet contact, defined by the customer or end user. Must be unique. String. Cannot start with **cont_**. - - contact_type - Type of contact. One of the following: - **personal** - An individual customer. - **business** - A business customer. - - country - The two-letter ISO 3166-1 ALPHA-2 code for the country. To determine the code for a country, see [List Countries](https://docs.rapyd.net/en/list-countries.md "List Countries"). - - created_at - Time of creation of the `contact` object, in [Unix time](https://docs.rapyd.net/en/glossary.md#UUID-945d98cf-adae-e1cf-2606-c7fae8b4a7e1_unix_time "Unix time"). - - date_of_birth - Date of birth of the individual. Format: **YYYY-MM-DD** - - email - Email address of the contact. - - ewallet - ID of the Rapyd Wallet that this contact is associated with. String starting with **ewallet_**. - - first_name - First name of the personal contact or primary person associated with the business contact. For a **personal** contact type, alphabetic characters and spaces. - - gender - Gender of the personal contact or primary person associated with the business contact. One of the following values: - **male** - **female** - **other** - **not_applicable** - - house_type - Description of the type of residency at the contact's residence. One of the following values: - **lease** - A long-term lease. - **live_with_family** - The contact lives with family. - **own** - The contact owns the residence. - **owner** - The contact is the owner of the residence. - **month_to_month** - An informal agreement, renewable each month. - **housing_project** - A room in a large residence facility, such as a residence hall or senior citizens' home. - - id - ID of the `contact` object. String starting with **cont_**. - - identification_number - ID number as shown by the ID document. - - identification_type - Type of the identification document associated with the contact. For types that are valid in the country, use [List Official Identification Documents](https://docs.rapyd.net/en/list-official-identification-documents.md "List Official Identification Documents"). - - issued_card_data - Describes additional information about the business contact for a company wallet. - - preferred_name - The name of the contact person. - - transaction_permissions - Indicates permissions for issuing transactions. Possible values: - **allowed** - **not_allowed** - - role_in_company - The role of the named person. One of the following values: - **owner** - Sole proprietor or partner. - **agent** - Authorized agent or attorney in fact. - **employee** - Authorized employee. - - last_name - Family name of the personal contact or primary person associated with the business contact. For a **personal** contact type, alphabetic characters and spaces. Required for issuing a card to a personal contact. - - marital_status - Marital status of the personal contact or primary person associated with the business contact. One of the following values: - **married** - **single** - **divorced** - **widowed** - **cohabiting** - **not_applicable** - - metadata - A JSON object defined by the client. See [Metadata](https://docs.rapyd.net/en/metadata.md "Metadata"). - - middle_name - Middle name of the personal contact or primary person associated with the business contact. - - mothers_name - Name of the mother of the personal contact or primary person associated with the business contact. Alphabetic characters and spaces. - - nationality - The citizenship of the contact. Two-letter ISO 3166-1 ALPHA-2 code for the country. To determine the code for a country, see [List Countries](https://docs.rapyd.net/en/list-countries.md "List Countries"). - - phone_number - Phone number of the contact in E.164 format. - - second_last_name - Second last name of the personal contact or primary person associated with the business contact. - - send_notifications - Determines whether Rapyd sends notifications to the contact. Default is **false**. - - verification_status - Result of the verification check. One of the following: - **not verified** - The contact has not been submitted for the Know Your Customer checks. - **KYCd** - The user has passed the Know Your Customer checks. ### Code Samples - - .NET - ```csharp using System; namespace RapydApiRequestSample { class Program { static void Main(string[] args) { try { string wallet = "ewallet_72b4ff39ca50dccc73c0ee65d85e124e"; string contact = "cont_abaa4abbe87afc22c97ac249d9302efe"; string result = RapydApiRequestSample.Utilities.MakeRequest("GET", $"/v1/ewallets/{wallet}/contacts/{contact}"); Console.WriteLine(result); } catch (Exception e) { Console.WriteLine("Error completing request: " + e.Message); } } } } ``` - - JavaScript - ```javascript onst makeRequest = require('/utilities').makeRequest; async function main() { try { const result = await makeRequest( 'GET', 'v1/ewallets/ewallet_72b4ff39ca50dccc73c0ee65d85e124e/contacts/cont_abaa4abbe87afc22c97ac249d9302efe' ); console.log(result); } catch (error) { console.error('Error completing request', error); } } ``` - - PHP - ```php /utilities.php"; include($path); try { $object = make_request('get', 'v1/ewallets/ewallet_72b4ff39ca50dccc73c0ee65d85e124e/contacts/cont_abaa4abbe87afc22c97ac249d9302efe'); var_dump($object); } catch(Exception $e) { echo "Error: $e"; } ?> ``` - - Python - ```python from pprint import pprint from utilities import make_request wallet = 'ewallet_72b4ff39ca50dccc73c0ee65d85e124e' contact = 'cont_abaa4abbe87afc22c97ac249d9302efe' results = make_request(method='get', path=f'/v1/ewallets/{wallet}/contacts/{contact}') pprint(results) ``` - /v1/ewallets/:wallet/contacts/:contact /v1/ewallets/:wallet/contacts/:contact - Retrieve Wallet Contact - ```curl curl -X get 'https://sandboxapi.rapyd.net/v1/ewallets/ewallet_3801e782955b29955445586a2405a5db/contacts/cont_cb60ec28c2f0bdfc621cfc21270c20ce' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "07d88535-3b1a-487f-be48-a31ec7065e4d" }, "data": { "id": "cont_cb60ec28c2f0bdfc621cfc21270c20ce", "first_name": "John", "last_name": "Doe", "middle_name": "", "second_last_name": "", "gender": "not_applicable", "marital_status": "not_applicable", "house_type": "", "contact_type": "personal", "phone_number": "+14155551237", "email": "", "identification_type": "", "identification_number": "", "issued_card_data": { "preferred_name": "", "transaction_permissions": "", "role_in_company": "" }, "date_of_birth": "2000-12-15", "country": "NG", "nationality": null, "address": { "id": "address_8dc883799f2fcb5adb92bf77b6bc85b7", "name": "John Doe", "line_1": "123 Main Street", "line_2": "", "line_3": "", "city": "Anytown", "state": "", "country": "", "zip": "", "phone_number": "", "metadata": {}, "canton": "", "district": "", "created_at": 1755679320 }, "ewallet": "ewallet_3801e782955b29955445586a2405a5db", "created_at": 1612104554, "metadata": {}, "business_details": null, "compliance_profile": 0, "verification_status": "not verified", "send_notifications": false, "mothers_name": "", "contact_reference_id": null } } ``` - Retrieve Wallet Contact by Contact Reference ID - ```curl curl -X get 'https://sandboxapi.rapyd.net/v1/ewallets/ewallet_053d64c44834e1d3057ecb68a34c6b6c/contacts/johndoe20251009' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' ``` - ```json { "status": { "error_code": "", "status": "SUCCESS", "message": "", "response_code": "", "operation_id": "b3c14fc0-9a80-4900-828a-52cc34bf0419" }, "data": { "id": "cont_3625cb4fc18d005b12f9ccf0c466755e", "first_name": "John", "last_name": "Doe", "middle_name": "", "second_last_name": "", "gender": "not_applicable", "marital_status": "not_applicable", "house_type": "", "contact_type": "business", "phone_number": "+14155551234", "email": "johndoefourstar@rapyd.net", "identification_type": "PA", "identification_number": "1234567890", "issued_card_data": { "preferred_name": "", "transaction_permissions": "", "role_in_company": "" }, "date_of_birth": "2000-11-22", "country": "US", "nationality": "NL", "address": { "id": "address_9706af91b503c70a819605222afabc96", "name": "John Doe - Four Star Professional Services", "line_1": "123 Main Street", "line_2": "", "line_3": "", "city": "Anytown", "state": "NY", "country": "US", "zip": "12345", "phone_number": "+14155551234", "metadata": {}, "canton": "", "district": "", "created_at": 1608023967 }, "ewallet": "ewallet_053d64c44834e1d3057ecb68a34c6b6c", "created_at": 1608023967, "metadata": { "merchant_defined": "updated" }, "business_details": { "id": "busi_9d2952408ec5dec780f5b88a8fc174aa", "name": "Four Star Professional Services", "registration_number": "R24032020000", "entity_type": "company", "industry_category": "company", "industry_sub_category": "home services", "address": { "id": "address_977b39b4b725fadc9040e1ee1e5df795", "name": "John Doe - Four Star Professional Services", "line_1": "1234 Main Street", "line_2": "Suite 1200", "line_3": "", "city": "Anytown", "state": "NY", "country": "US", "zip": "10101", "phone_number": "14155557779", "metadata": { "merchant_defined": true }, "canton": "", "district": "", "created_at": 1608023967 }, "created_at": 1608023967, "annual_revenue": 0, "establishment_date": null, "legal_entity_type": null, "cnae_code": null, "statement_descriptor": null, "mcc": null, "website_url": null, "customer_service_phone_number": null }, "authorized_user_details": { "first_name": "John", "last_name": "Doe", "date_of_birth": "2000-11-22", "country": "US" }, "compliance_profile": 0, "verification_status": "not verified", "send_notifications": false, "mothers_name": "Jane Smith", "contact_reference_id": "johndoe20251009" } } ``` - Bad Request - Wallet Contact Not Found - ```curl curl -X get 'https://sandboxapi.rapyd.net/v1/ewallets/ewallet_72b4ff39ca50dccc73c0ee65d85e124e/contacts/cont_abaa4abbe87afc22c97ac249d9302efe' \ -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' ``` - ```json { "status": { "error_code": "ERROR_GET_EWALLET_CONTACT", "status": "ERROR", "message": "The request attempted an operation that requires a wallet contact, but the contact was not found. The request was rejected. Corrective action: In the path, specify the ID of a valid wallet, a string starting with 'ewallet_', and the ID of a valid contact belonging to that wallet, a string starting with 'cont_'.", "response_code": "ERROR_GET_EWALLET_CONTACT", "operation_id": "36f3bdfa-d2a4-4ef9-9d74-74c3c3a5326f" } } ```