Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Merges

Merge profiles

post/merges

Headers

X-Organization-Idstring required

Organization ID

Request body

profileIdsstring[]
firstNamestring

First name

lastNamestring

Last name

emailstring email

Email address

phonestring

Phone number

cellPhonestring nullable

Cellphone number

birthdaystring date nullable

Birthday

gender'M' | 'W' | 'N/A' nullable

Gender

photoIdstring nullable

Photo ID

statusIdstring nullable

Profile Status ID

countrystring

Two digit Country Code. ISO 3166-1 alpha-2

statestring nullable

State

citystring nullable

City

address1string nullable

Address line 1

address2string nullable

Address Line 2

zipstring nullable

ZIP code

documentType'na' | 'driver_licence' | 'student_id' | 'passport' | 'dni' | 'nie' | 'social_security_card'

Document type

documentNumberstring

Document number

documentIssueDatestring date nullable

Document issue date

documentIssuingCountrystring nullable

Document issuing country code. ISO 3166-1 alpha-2

documentExpirationDatestring date nullable

Document expiration date

taxIdstring nullable

Tax ID

companyNamestring nullable

Company name

companyTaxIdstring nullable

Company tax ID

isOptInboolean

Opt-in status

Example request

{
  "profileIds": [
    "8723618905976902",
    "8723618905976903"
  ],
  "firstName": "John",
  "lastName": "Smith",
  "email": "John",
  "phone": "+1 123 456 7890",
  "birthday": "1953-03-05",
  "country": "CA",
  "state": "ON",
  "city": "Toronto",
  "address1": "100 Yonge Street",
  "zip": "M5C 2W1",
  "documentType": "na",
  "isOptIn": true
}

Response

Response

idstring

Merge unique identifier

mergeAtstring date

Merge date

eventType'merge' | 'unmerge'

Event type

Example response

{
  "beforeMergeProfiles": [
    {
      "photoId": 12345,
      "taxId": "12345",
      "companyTaxId": "12345",
      "statusId": 12,
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "123456789",
      "cellPhone": "123456789",
      "birthday": "1970-01-01",
      "gender": "M",
      "companyName": "Company",
      "address1": "Address line 1",
      "address2": "Address line 2",
      "city": "City",
      "country": "US",
      "countryName": "United States",
      "state": "State",
      "zip": "12345",
      "documentType": "driver_licence",
      "documentNumber": "123456789",
      "documentIssueDate": "1970-01-01",
      "documentIssuingCountry": "US",
      "documentExpirationDate": "1970-01-01",
      "id": "123456788",
      "organizationId": "12345",
      "statusName": "VIP",
      "statuses": [
        {
          "id": 1,
          "name": "VIP"
        },
        {
          "id": 2,
          "name": "Regular"
        }
      ],
      "dateCreated": "2024-08-06T13:38:35+00:00",
      "dateModified": "2024-08-06T16:58:59+00:00",
      "dateAnonymized": "2024-08-06T16:58:59+00:00",
      "parentId": "123456789",
      "photo": {
        "fileId": "12345",
        "path": "https://amazonaws.com/photo-jumbo~~67816f854de79.jpg",
        "croppedImage": "https://amazonaws.com/photo-jumbo_thumb~~67816f857ccab.jpg",
        "height": 797,
        "width": 1000,
        "cropParam": {
          "width": 75.140625,
          "height": 75.140625,
          "x": 212.12890625,
          "y": 210.203125
        }
      },
      "isAnonymizationAvailable": true
    }
  ],
  "afterMergeProfiles": [
    {
      "photoId": 12345,
      "taxId": "12345",
      "companyTaxId": "12345",
      "statusId": 12,
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "phone": "123456789",
      "cellPhone": "123456789",
      "birthday": "1970-01-01",
      "gender": "M",
      "companyName": "Company",
      "address1": "Address line 1",
      "address2": "Address line 2",
      "city": "City",
      "country": "US",
      "countryName": "United States",
      "state": "State",
      "zip": "12345",
      "documentType": "driver_licence",
      "documentNumber": "123456789",
      "documentIssueDate": "1970-01-01",
      "documentIssuingCountry": "US",
      "documentExpirationDate": "1970-01-01",
      "id": "123456788",
      "organizationId": "12345",
      "statusName": "VIP",
      "statuses": [
        {
          "id": 1,
          "name": "VIP"
        },
        {
          "id": 2,
          "name": "Regular"
        }
      ],
      "dateCreated": "2024-08-06T13:38:35+00:00",
      "dateModified": "2024-08-06T16:58:59+00:00",
      "dateAnonymized": "2024-08-06T16:58:59+00:00",
      "parentId": "123456789",
      "photo": {
        "fileId": "12345",
        "path": "https://amazonaws.com/photo-jumbo~~67816f854de79.jpg",
        "croppedImage": "https://amazonaws.com/photo-jumbo_thumb~~67816f857ccab.jpg",
        "height": 797,
        "width": 1000,
        "cropParam": {
          "width": 75.140625,
          "height": 75.140625,
          "x": 212.12890625,
          "y": 210.203125
        }
      },
      "isAnonymizationAvailable": true
    }
  ]
}