BVbvnk
Contacts

Create contact

Changed on

:::warning Beta Contacts v3 is in beta and may change as we continue to improve it. Please review the documentation and endpoints carefully, test everything in the sandbox, and reach out to the Solutions team if you need help. :::

Creates a new contact that can be referenced in payment requests instead of supplying inline party details. Contacts store originator or beneficiary information required for Travel Rule compliance.

A contact can represent either an INDIVIDUAL (natural person) or a COMPANY (legal entity). Once created, reference the returned id as contactId when creating payment links, channels, or payouts.

post/platform/v3/contacts

Request

Request body

descriptionstring

A human-readable label for the contact.

category'DEFAULT'

Contact category.

Example request

{
  "description": "Primary payment partner",
  "category": "DEFAULT",
  "entity": {
    "type": "INDIVIDUAL",
    "relationshipType": "THIRD_PARTY",
    "firstName": "Jane",
    "lastName": "Doe",
    "dateOfBirth": "1990-06-15",
    "address": {
      "addressLine1": "10 Downing Street",
      "city": "London",
      "region": "Greater London",
      "stateCode": "NY",
      "postalCode": "SW1A 2AA",
      "country": "GB"
    }
  }
}

Response

Contact created

idstring uuid

Unique identifier of the contact.

descriptionstring

A human-readable label for the contact.

categorystring

Contact category.

createdAtstring date-time

Timestamp when the contact was created.

updatedAtstring date-time

Timestamp when the contact was last updated.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "description": "Primary payment partner",
  "category": "DEFAULT",
  "entity": {
    "type": "INDIVIDUAL",
    "relationshipType": "THIRD_PARTY",
    "firstName": "Jane",
    "lastName": "Doe",
    "dateOfBirth": "1990-06-15",
    "address": {
      "addressLine1": "10 Downing Street",
      "city": "London",
      "region": "Greater London",
      "stateCode": "NY",
      "postalCode": "SW1A 2AA",
      "country": "GB"
    }
  },
  "createdAt": "2026-06-10T10:30:00Z",
  "updatedAt": "2026-06-10T10:30:00Z"
}

Changes