Skip to content
Leapa
Leapa.co
Sign in

Get a customer by reference Id

GET https://api.leapa.co/v2/customers/reference/{reference_id}

This endpoint needs your API key

Send it as a bearer token in the Authorization header. A request without one is answered with 401. See Authentication for where to find your key and how to keep it secret.

Request

curl -X GET "https://api.leapa.co/v2/customers/reference/ref_9f2a17c4" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Accept: application/json"

Response

OK

{
  "id": "obj_5f21c8a40b",
  "object": "string",
  "email": "jeanne@example.com",
  "address": {
    "object": "string",
    "city": "string",
    "type": "personal",
    "status": "invalid",
    "state": "string",
    "zip": "string",
    "line1": "string",
    "line2": "string"
  },
  "status": "active",
  "first_name": "Jeanne",
  "last_name": "Ndayishimiye",
  "birth_date": "2026-01-31",
  "phone_number": "+25779123456",
  "merchant_name": "Jeanne Ndayishimiye",
  "merchant_id": "mer_1b47d0e9ca",
  "sources": [
    {
      "fingerprint": "string",
      "currency": "BIF",
      "type": "bank",
      "account_id": "acc_62f3a8d15b",
      "default": false
    }
  ],
  "destinations": [
    {
      "currency": "BIF",
      "type": "bank",
      "account_id": "acc_62f3a8d15b",
      "default_destination": false
    }
  ],
  "live": false,
  "reference_id": "ref_9f2a17c4"
}

Path parameters

Values that go into the URL itself.

  • reference_idstringrequired
    Example:ref_9f2a17c4

Response

application/json
  • idstring

    Customer Unique ID

  • objectstring

    Customer - Object Returned

  • emailstring

    Customer email

  • addressAddressResponse
  • statusstring

    Customer Status

    Allowed values:activedeactivatedeleted
  • first_namestring

    Customer firstname

  • last_namestring

    Customer lastname

  • birth_datestring

    Customer birthdate

  • phone_numberstring

    Customer phone number

  • merchant_namestring

    Merchant name associated to this Customer

  • merchant_idstring

    Merchant ID associated to this Customer

  • sourcesarray of AccountCustomerSourceReferenceResponse

    List of all Account Reference source of the customer

  • destinationsarray of AccountCustomerDestinationReferenceResponse

    List of all Account Reference destination of the customer

  • liveboolean

    Whether the object exist in live or test mode.

  • reference_idstring

    Reference Id

Status codes

  • 200OK
  • 400Bad request
  • 401Unauthorized
  • 402Payment required
  • 403Forbidden
  • 404Not found
  • 428Precondition required
  • 500Server error

Request

curl -X GET "https://api.leapa.co/v2/customers/reference/ref_9f2a17c4" \
  -H "Authorization: Bearer $LEAPA_API_KEY" \
  -H "Accept: application/json"

Response

OK

{
  "id": "obj_5f21c8a40b",
  "object": "string",
  "email": "jeanne@example.com",
  "address": {
    "object": "string",
    "city": "string",
    "type": "personal",
    "status": "invalid",
    "state": "string",
    "zip": "string",
    "line1": "string",
    "line2": "string"
  },
  "status": "active",
  "first_name": "Jeanne",
  "last_name": "Ndayishimiye",
  "birth_date": "2026-01-31",
  "phone_number": "+25779123456",
  "merchant_name": "Jeanne Ndayishimiye",
  "merchant_id": "mer_1b47d0e9ca",
  "sources": [
    {
      "fingerprint": "string",
      "currency": "BIF",
      "type": "bank",
      "account_id": "acc_62f3a8d15b",
      "default": false
    }
  ],
  "destinations": [
    {
      "currency": "BIF",
      "type": "bank",
      "account_id": "acc_62f3a8d15b",
      "default_destination": false
    }
  ],
  "live": false,
  "reference_id": "ref_9f2a17c4"
}