---
title: "Check contacts"
method: POST
path: "/v1/contacts/check"
tags: ["Contacts"]
---

# Check contacts

`POST /v1/contacts/check`

## Request

- Base URL: `https://contacts-api.paymongo.com`
- URL: `https://contacts-api.paymongo.com/v1/contacts/check`
- Auth: HTTP basic

Check which of the given emails and phones are already attached to existing contacts. Returns per-value in_use flags with the owning contact_id.

## Request body

- CheckRequestDTO
  - `emails` string[]
  - `phones` string[]

## Response `200`

OK

- CheckWithErrorsResponseDTO
  - `data` CheckResponseDTO
    - `emails` CheckItemDTO[]
      - `contact_id` string
      - `in_use` boolean
      - `value` string
    - `phones` CheckItemDTO[]
      - `contact_id` string
      - `in_use` boolean
      - `value` string
  - `errors` ErrorDetail[]
    - `code` 'invalid_query_parameters' | 'invalid_request_body' | 'parameter_required' | 'not_found' | 'unauthorized' | 'forbidden' | 'resource_conflict' | 'internal_server_error'
    - `detail` string: Detail is a human-readable explanation specific to this occurrence of the problem.
    - `source` Source: Source of the error, providing context like JSON Pointer or query parameter
      - `conflicting_id` string: ConflictingID is the ID of the resource that caused a conflict error.
      - `header` string: Header indicates the name of a single request header which caused the error.
      - `parameter` string: Parameter indicates which URI query parameter caused the error.
      - `pointer` string: Pointer is a "JSON Pointer" [RFC6901] to the value in the request document that caused the error.
      - `value` string: Value is the input value that caused the error.
  - `meta` CheckMetaDTO
    - `errors` integer
    - `requested` integer
    - `resolved` integer

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `500`: Internal Server Error

---

[API](https://skmtc.dev/paymongo/apis/contacts-api.md) - [All operations](https://skmtc.dev/paymongo/apis/contacts-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paymongo/apis/contacts-api/revisions/b5416b944e43?raw)