AggKnowledge API

Contact Info

Endpointhttps://api.aggknowledgeai.com

V2 APIs for contact information

Request contact information

POST

https://api.aggknowledgeai.com

/v2/{environment}/person/contact-info

Submit a batch of person contact info enrichment requests (Tier 3)

Request contact information › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Request contact information › Headers

x-api-key

string · required

API key for authentication

Request contact information › Request Body

Contact info request

object[]

Request contact information › Responses

Contact info request accepted

batchId

string

Batch UUID for tracking the request

itemCount

integer · int32

Number of items in the request

message

string

Status message

POST/v2/{environment}/person/contact-info

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/person/contact-info \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "requests": [
    {
      "aggkPersonId": 0,
      "enrichPersonalEmail": true,
      "enrichPhone": true,
      "enrichWorkEmail": true,
      "metadata": {
        "key": {}
      }
    }
  ]
}
'

shell

Example Request Body

{
  "requests": [
    {
      "aggkPersonId": 0,
      "enrichPersonalEmail": true,
      "enrichPhone": true,
      "enrichWorkEmail": true,
      "metadata": {
        "key": {}
      }
    }
  ]
}

json

Example Responses

{
  "batchId": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a",
  "itemCount": 50,
  "message": "Contact info request accepted and processing"
}

json

application/json

Get contact data batch status

GET

https://api.aggknowledgeai.com

/v2/{environment}/person/contact-info/{id}

Returns the status of a contact data batch (Tier 4)

Get contact data batch status › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

id

string · required

Batch UUID

Get contact data batch status › Headers

x-api-key

string · required

API key for authentication

Get contact data batch status › Responses

Batch status

completedItems

integer · int32

Number of completed items

failedItems

integer · int32

Number of failed items

id

string

Batch UUID

object[]

List of contact data items

status

string

Batch status

totalItems

integer · int32

Total number of items in the batch

GET/v2/{environment}/person/contact-info/{id}

curl --request GET \
  --url https://api.aggknowledgeai.com/v2/:environment/person/contact-info/:id \
  --header 'x-api-key: <string>'

shell

Example Responses

{
  "completedItems": 45,
  "failedItems": 5,
  "id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a",
  "items": [
    {
      "aggkPersonId": 123,
      "emails": {
        "array": true,
        "bigDecimal": true,
        "bigInteger": true,
        "binary": true,
        "boolean": true,
        "container": true,
        "double": true,
        "embeddedValue": true,
        "empty": true,
        "float": true,
        "floatingPointNumber": true,
        "int": true,
        "integralNumber": true,
        "long": true,
        "missingNode": true,
        "nodeType": "ARRAY",
        "null": true,
        "number": true,
        "object": true,
        "pojo": true,
        "short": true,
        "string": true,
        "textual": true,
        "valueNode": true
      },
      "enrichPersonalEmail": false,
      "enrichPhone": true,
      "enrichWorkEmail": true,
      "metadata": {
        "array": true,
        "bigDecimal": true,
        "bigInteger": true,
        "binary": true,
        "boolean": true,
        "container": true,
        "double": true,
        "embeddedValue": true,
        "empty": true,
        "float": true,
        "floatingPointNumber": true,
        "int": true,
        "integralNumber": true,
        "long": true,
        "missingNode": true,
        "nodeType": "ARRAY",
        "null": true,
        "number": true,
        "object": true,
        "pojo": true,
        "short": true,
        "string": true,
        "textual": true,
        "valueNode": true
      },
      "mostProbablePersonalEmail": "[email protected]",
      "mostProbablePersonalEmailStatus": "HIGH_PROBABILITY",
      "mostProbablePhone": "+1 555-1234",
      "mostProbableWorkEmail": "[email protected]",
      "mostProbableWorkEmailStatus": "HIGH_PROBABILITY",
      "personalEmails": {
        "array": true,
        "bigDecimal": true,
        "bigInteger": true,
        "binary": true,
        "boolean": true,
        "container": true,
        "double": true,
        "embeddedValue": true,
        "empty": true,
        "float": true,
        "floatingPointNumber": true,
        "int": true,
        "integralNumber": true,
        "long": true,
        "missingNode": true,
        "nodeType": "ARRAY",
        "null": true,
        "number": true,
        "object": true,
        "pojo": true,
        "short": true,
        "string": true,
        "textual": true,
        "valueNode": true
      },
      "phones": {
        "array": true,
        "bigDecimal": true,
        "bigInteger": true,
        "binary": true,
        "boolean": true,
        "container": true,
        "double": true,
        "embeddedValue": true,
        "empty": true,
        "float": true,
        "floatingPointNumber": true,
        "int": true,
        "integralNumber": true,
        "long": true,
        "missingNode": true,
        "nodeType": "ARRAY",
        "null": true,
        "number": true,
        "object": true,
        "pojo": true,
        "short": true,
        "string": true,
        "textual": true,
        "valueNode": true
      },
      "status": "completed"
    }
  ],
  "status": "completed",
  "totalItems": 50
}

json

application/json

Person Asynchronous Discover Basic

Request contact information

POST

https://api.aggknowledgeai.com

/v2/{environment}/person/contact-info

Submit a batch of person contact info enrichment requests (Tier 3)

Request contact information › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Request contact information › Headers

x-api-key

string · required

API key for authentication

Request contact information › Request Body

Contact info request

object[]

Request contact information › Responses

Contact info request accepted

batchId

string

Batch UUID for tracking the request

itemCount

integer · int32

Number of items in the request

message

string

Status message

Get contact data batch status

GET

https://api.aggknowledgeai.com

/v2/{environment}/person/contact-info/{id}

Returns the status of a contact data batch (Tier 4)

Get contact data batch status › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

id

string · required

Batch UUID

Get contact data batch status › Headers

x-api-key

string · required

API key for authentication

Get contact data batch status › Responses

Batch status

completedItems

integer · int32

Number of completed items

failedItems

integer · int32

Number of failed items

id

string

Batch UUID

object[]

List of contact data items

status

string

Batch status

totalItems

integer · int32

Total number of items in the batch