Get customer by phone number

GET 
https://core-prod.malipopay.co.tz/api/v1/customer/phoneNumber/:phoneNumber

Returns a customer record matching the given phone number

Request

Path Parameters

phoneNumber stringrequired

Customer phone number

Responses

200

Customer fetched successfully

application/json

Schema

Schema

_idstring
Unique identifier for the customer
Example: 6281559426fa29659c5ac38a
phoneNumberstring
Example: 255742200105
firstnamestring
Example: John
lastnamestring
Example: Doe
emailemail
Example: john.doe@example.com
typestring
Example: INDIVIDUAL
projectstring
Project ID this customer belongs to
Example: 63db68a6c5f3e7682e23c2ca
deletedboolean
Example: false
createdAtdate-time
Example: 2023-02-02T07:39:18.979Z
updatedAtdate-time
Example: 2023-02-02T07:39:24.934Z

Example (auto)

{
  "_id": "6281559426fa29659c5ac38a",
  "phoneNumber": "255742200105",
  "firstname": "John",
  "lastname": "Doe",
  "email": "john.doe@example.com",
  "type": "INDIVIDUAL",
  "project": "63db68a6c5f3e7682e23c2ca",
  "deleted": false,
  "createdAt": "2023-02-02T07:39:18.979Z",
  "updatedAt": "2023-02-02T07:39:24.934Z"
}

400

Customer not found

application/json

Schema

Schema

codeint32required
messagestringrequired

Example (auto)

{
  "code": 0,
  "message": "string"
}

Authorization: apiToken

name: apiTokentype: apiKeyin: headerdescription: Project API key. Get yours from the Malipopay dashboard under Settings → API Keys.

• curl
• python
• nodejs
• php
• java
• go

• CURL

curl -L 'https://core-prod.malipopay.co.tz/api/v1/customer/phoneNumber/:phoneNumber' \
-H 'Accept: application/json' \
-H 'apiToken: <apiToken>'

Request

Base URL

https://core-prod.malipopay.co.tz

Auth

apiToken

Parameters

phoneNumber — pathrequired

Response

Click the Send API Request button above and see the response here!