⁍ MatchMove Banking Operating System

Sections

Theme switcher

Gets detailed information of a user

Header Parameters

Authorizationstring

Query Parameters

emailstring

Email Address (from users table)

mobilestring

Full mobile (concatenated value of country code and mobile number)

user_hash_idstring

User identifier

user_statusstring

User State

Enum values:
activesuspendedblocked
kyc_statusstring

User KYC State

Enum values:
pendingsubmittedapprovedrejected
first_namestring

first name to search

last_namestring

last name to search

customer_idstring

Customer ID to search

Max length
50
id_typestring

ID Type to search

id_numberstring

ID number to search

id_date_issuestring

ID issue date to search

id_date_expirystring

ID expiry date to search

birthdaystring

Birthday to search

card_identifierstring

Card Identifier:

  • proxy - Card Proxy number to search
  • mask - Masked card number to search
  • full - Full(actual) card number to search
Enum values:
proxymaskfull
card_identifier_valuestring

Value is dependent on the card_identifier parameter

balance_conditionstring

Balances Condition:

  • gt - Amount greater than or equal to specified balance
  • lt - Amount lesser than or equal to specified balance
  • eq - Amount equal to specified balance
Default value
eq
Enum values:
gtlteq
card_available_balancenumber

Get all users where its per card available balance is within the specified balance_condition parameter

card_withholding_balancenumber

Get all users where its per card withholding balance is within the specified balance_condition parameter

wallet_available_balancenumber

Get all users where its per wallet available balance is within the specified balance_condition parameter

wallet_withholding_balancenumber

Get all users where its per wallet withholding balance is within the specified balance_condition parameter

transaction_referencestring

Get all users given the transaction reference (will apply to all transaction types)

match_typestring

Matching Condition:

  • fuzzy - endpoint will perform a LIKE condition in query
  • exact - endpoint will perform an EQUAL condition in query
Enum values:
fuzzyexact
response_typestring

Matching Condition:

  • expand - response will show an expandable/complete information for address, documents, wallets object
  • condense - response will show a url link on information for address, documents, wallets object
Enum values:
expandcondense
filter_conditionstring

Matching Condition:

  • AND - for 2 or more filter parameters, the query will perform an AND operation in query
  • OR - for 2 or more filter parameters, the query will perform an OR operation in query
Default value
AND
Enum values:
ANDOR
pagenumber

Page Number to display

Default value
1
records_per_pagenumber

Records per page to display

Default value
10
partner_idstring

Partner Id

Max length
50
agent_idstring

Agent ID to search

Max length
50
client_reference_idstring

Client Reference ID to search

Max length
50

Response

200
Object
A paginated list of detailed information per user

Response Attributes

usersarray

Users information

Show child attributes

total_recordsinteger
records_per_pageinteger
total_pagesinteger
linksarray

Show child attributes

400
Object
Bad Request

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
401
Object
Unauthorized request

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
403
Object
Forbidden

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
404
Object
Resource not found

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
500
Object
Internal server Error

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
502
Object
Bad Gateway

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
503
Object
External Service Error

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
504
Object
Gateway timeout

Response Attributes

codeinteger Required
descriptionstring Required
linkstring Required
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?