Contact Updated Webhook

The CONTACT_UPDATED webhook notifies the client that an existing contact has been updated.

Parameters

Webhook Header Parameters

Webhook Root Parameters

- created_at
- Time that the webhook was created, in Unix time.
  Note
  Inside the data object, some webhooks have another created_at field that refers to a different event.
- data
- Contains the actual data of the webhook.
  For details, see below.
- extended_timestamp
- Time in milliseconds that the webhook was created, in Unix time.
- id
- ID of the webhook. String starting with wh_.
- status
- Status of the webhook. One of the following:
  - NEW
  - CLO - Closed.
  - ERR - Error.
  - RET - Re-sent.
  Note
  Inside the data object, some webhooks have another status field that refers to a different event.
- trigger_operation_id
- ID of the operation that triggered the webhook. UUID.
- type
- Name of the webhook type.
  Note
  The name in the Client Portal is different.

Webhook Data 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.
- 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.
  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.
  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. 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.
- 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.

CONTACT_UPDATED Webhook

{
  "id": "wh_dc3ff53ec8c76322e9d74cb186091b7b",
  "type": "CONTACT_UPDATED",
  "data": {
    "id": "cont_25ee38f0a661ccf9364064e3dd0ed37c",
    "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": "+12125554321",
    "email": "john.doe@sample12345.net",
    "identification_type": "DL",
    "identification_number": "123243434",
    "issued_card_data": {
      "preferred_name": "",
      "transaction_permissions": "",
      "role_in_company": ""
    },
    "date_of_birth": null,
    "country": "IN",
    "nationality": null,
    "address": null,
    "ewallet": "ewallet_64736c5bc9875fdd9b6501bb41a992cb",
    "created_at": 1706183438,
    "metadata": {},
    "business_details": null,
    "compliance_profile": 0,
    "verification_status": "not verified",
    "send_notifications": false,
    "mothers_name": "",
    "contact_reference_id": null
  },
  "trigger_operation_id": "47399680-f732-40c2-82cc-546b403b768c",
  "status": "NEW",
  "created_at": 1768827355,
  "extended_timestamp": 1768827355833000
}

CONTACT_UPDATED Webhook - Business Contact

{
  "id": "wh_a1b2c3d4e5f67890123456789abcdef01",
  "type": "CONTACT_UPDATED",
  "data": {
    "id": "cont_3625cb4fc18d005b12f9ccf0c466755e",
    "first_name": "Four Star Professional Services",
    "last_name": "",
    "middle_name": "",
    "second_last_name": "",
    "gender": "not_applicable",
    "marital_status": "not_applicable",
    "house_type": "",
    "contact_type": "business",
    "phone_number": "+14155551234",
    "email": "contact@fourstar.com",
    "identification_type": "PA",
    "identification_number": "1234567890",
    "issued_card_data": {
      "preferred_name": "",
      "transaction_permissions": "",
      "role_in_company": ""
    },
    "date_of_birth": null,
    "country": "US",
    "nationality": null,
    "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": 1706183438
    },
    "ewallet": "ewallet_053d64c44834e1d3057ecb68a34c6b6c",
    "created_at": 1706183438,
    "metadata": {},
    "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": {},
        "canton": "",
        "district": "",
        "created_at": 1706183438
      },
      "created_at": 1706183438,
      "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": "1994-01-01",
      "country": "US"
    },
    "compliance_profile": 0,
    "verification_status": "not verified",
    "send_notifications": false,
    "mothers_name": "",
    "contact_reference_id": null
  },
  "trigger_operation_id": "47399680-f732-40c2-82cc-546b403b768c",
  "status": "NEW",
  "created_at": 1768827355,
  "extended_timestamp": 1768827355833000
}

In this section:

Documentation

Contact Updated Webhook

Note

Parameters

Webhook Header Parameters

Webhook Root Parameters

Note

Note

Note

Webhook Data Parameters

Search results