Retrieve Wallet Contact

Retrieve a contact for an existing Rapyd Wallet.

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

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.
- business_details
- Describes additional information for business entities. Required when type is company.
  address
  Principal address of the business. Values for name and line1 are. See 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.
  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. Required. 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.
  name
  Business name.
  registration_number
  Registration number.
- 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.
- created_at
- Time of creation of the contact object, in 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.
- 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.
- 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.
- 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

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

onst makeRequest = require('<path-to-your-utility-file>/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
$path = $_SERVER['DOCUMENT_ROOT'];
$path .= "/<path-to-your-utility-file>/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

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_reference_id

Retrieve Wallet Contact

curl -X get
https://sandboxapi.rapyd.net/v1/ewallets/ewallet_8d2d52f431a4d3d9d49aab3df94a2adf/contacts/cont_4bd588fb8a711a4dbd5c1f21989780d2
-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'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "ef42cf95-cf77-4794-a042-601b319d1567"
    },
    "data": {
        "id": "cont_4bd588fb8a711a4dbd5c1f21989780d2",
        "first_name": "Jane",
        "last_name": "Doe",
        "middle_name": "",
        "second_last_name": "",
        "gender": "female",
        "marital_status": "single",
        "house_type": "lease",
        "contact_type": "personal",
        "phone_number": "+14155551997",
        "email": "jane200@rapyd.net",
        "identification_type": "PA",
        "identification_number": "1233242424",
        "issued_card_data": {
            "preferred_name": "",
            "transaction_permissions": "",
            "role_in_company": ""
        },
        "date_of_birth": "2000-11-22",
        "country": "US",
        "nationality": "FR",
        "address": {
            "id": "address_4ea38a3d61d383f03d424cb80189b21a",
            "name": "Jane Doe",
            "line_1": "123 Lake Forest Drive",
            "line_2": "",
            "line_3": "",
            "city": "Anytown",
            "state": "NY",
            "country": "",
            "zip": "12345",
            "phone_number": "+14155551234",
            "metadata": {
                "merchant_defined": true
            },
            "canton": "",
            "district": "",
            "created_at": 1625581619
        },
        "ewallet": "ewallet_8d2d52f431a4d3d9d49aab3df94a2adf",
        "created_at": 1625581619,
        "metadata": {
            "merchant_defined": "updated"
        },
        "business_details": null,
        "compliance_profile": 0,
        "verification_status": "not verified",
        "send_notifications": false,
        "mothers_name": "Jane Smith"
    }
}

Retrieve Wallet Contact by Contact Reference ID

curl -X get
https://sandboxapi.rapyd.net/v1/ewallets/ewallet_ca8e764afff51baa58eb47a52da6b5b0/contacts/johndoe
-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'

{
    "status": {
        "error_code": "",
        "status": "SUCCESS",
        "message": "",
        "response_code": "",
        "operation_id": "e36924c2-91cf-4a42-ad78-c23e3ad7f1f6"
    },
    "data": {
        "id": "cont_88e387ef31488c0f4b385d157a27425a",
        "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": "+123456789",
        "email": "johndoe@rapyd.net",
        "identification_type": "DL",
        "identification_number": "1234567890",
        "issued_card_data": {
            "preferred_name": "",
            "transaction_permissions": "",
            "role_in_company": ""
        },
        "date_of_birth": "2000-11-22",
        "country": "IS",
        "nationality": "IS",
        "address": {
            "id": "address_b6d52e34fffce3c20d6000dd6faea3a2",
            "name": "John Doe",
            "line_1": "123 Main Street",
            "line_2": "",
            "line_3": "",
            "city": "Anytown",
            "state": "NY",
            "country": "US",
            "zip": "12345",
            "phone_number": "+15555555555",
            "metadata": {},
            "canton": "",
            "district": "",
            "created_at": 1694069068
        },
        "ewallet": "ewallet_ca8e764afff51baa58eb47a52da6b5b0",
        "created_at": 1694069068,
        "metadata": {
            "merchant_defined": true
        },
        "business_details": null,
        "compliance_profile": 0,
        "verification_status": "not verified",
        "send_notifications": false,
        "mothers_name": "Jane Smith",
        "contact_reference_id": "johndoe"
    }
}

In this section:

Documentation

Retrieve Wallet Contact

Parameters

Request Path Parameters

Request Header Parameters

Response Parameters

Code Samples

Search results