---
title: "Get a Contact"
method: GET
path: "/contacts/{id}"
tags: ["Contacts"]
---

# Get a Contact

`GET /contacts/{id}`

Get a single Contact by its ID

## Path parameters

- `id` string, UUID, required

## Response `200`

OK

- GetAContactResponse
  - `data` object, required
    - `id` string, uuid, required — The Contact ID
    - `ref` string, string, required — The Contact ref
    - `name` string, required — The Contact name (Min: 3 - Max: 140)
    - `email` string, email, required — The Contact email (Min: 6 - Max: 256)
    - `type` 'Zepto account' | 'anyone', required — (Deprecated) The Contact account type
    - `metadata` Metadata, required — Use for your custom data and certain Zepto customisations.
    - `bank_account` object, required
      - `id` string, uuid — The Bank Account ID
      - `account_number` string — The Bank Account number (Min: 5 - Max: 9)
      - `branch_code` string — The BSB number (Min: 6 - Max: 6)
      - `state` 'active' | 'removed' — The bank account state
      - `iav_provider` 'split' | 'proviso' | 'basiq' | 'credit_sense' | 'null', nullable — The instant account verification provider
      - `iav_status` 'active' | 'removed' | 'credentials_invalid' | 'null', nullable — The instant account verification bank connection status
      - `blocks` object
        - `debits_blocked` boolean — Used by Zepto admins. Defines whether the bank account is blocked from being debited
        - `credits_blocked` boolean — Used by Zepto admins. Defined Whether this bank account is blocked from being credited
    - `anyone_account` object, required
      - `id` string, uuid — (Deprecated) The Anyone Account ID
    - `bank_connection` object
      - `id` string, uuid, nullable — The bank connection ID
    - `links` object
      - `add_bank_connection` string, url — A unique URL to share with the Contact in order to establish a new bank connection to their bank account
    - `payid_details` object
      - `alias_value` string, email — The PayID email
      - `alias_type` string — Type of PayID. Fixed to `email`
      - `alias_name` string — Your merchant's alias_name
      - `state` 'pending' | 'active' | 'failed' | 'deregistered' — Pending -> Active or Failed -> Deregistered (Contact removed)

## Other responses

- `404` — Not Found

---

[API](https://skmtc.net/zeptopayments/apis/zepto-api.md) · [All operations](https://skmtc.net/zeptopayments/apis/zepto-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zeptopayments/zepto-api/revisions/6353e9b9af6f/schema)