Noba Server

Health Check
- Checks if the Noba service is up and runningget
Assets
Authentication
- Submits the one-time passcode (OTP) to retreive an API access tokenpost
- Logs user in and sends one-time passcode (OTP) to the provided email addresspost
Consumer
Partner
Transactions
Verification

Noba Server

Health Check
- Checks if the Noba service is up and runningget
Assets
Authentication
- Submits the one-time passcode (OTP) to retreive an API access tokenpost
- Logs user in and sends one-time passcode (OTP) to the provided email addresspost
Consumer
Partner
Transactions
Verification

Gets details of logged-in consumer

get https://api-partner.noba.com/v1/consumers

URL Expired

The URL for this request expired after 30 days.

❗️
This endpoint is critical for proper user routing
To route users through the onramp flow, this endpoint must be called in order to identify a user's current KYC status.

📘
This endpoint is used for proper front-end parameter population
The collected user data can be retrieved via this endpoint for proper population of user data on the front end.

Headers

x-noba-api-key

string

required

x-noba-signature

string

x-noba-timestamp

string

Timestamp in milliseconds, use: new Date().getTime().toString()

Responses

Response body

object

_id

string

required

firstName

string

lastName

string

required

handle

string

required

status

string

required

Approved Pending ActionRequired TemporaryHold PermanentHold

kycVerificationData

object

required

kycVerificationStatus

string

required

NotSubmitted Pending Approved Rejected

updatedTimestamp

number

documentVerificationData

object

required

documentVerificationStatus

string

NotRequired NotSubmitted Pending Verified ActionRequired Rejected

documentVerificationErrorReason

string

RequiresRecapture PoorQuality SizeOrType

updatedTimestamp

number

phone

string

dateOfBirth

string

address

object

Has additional fields

paymentMethods

array of objects

paymentMethods

object

name

string

type

string

required

Card ACH

imageUri

string

paymentToken

string

required

cardData

object

achData

object

isDefault

boolean

required

cryptoWallets

array of objects

cryptoWallets

object

walletName

string

address

string

required

chainType

string

isEVMCompatible

boolean

paymentMethodStatus

string

Approved Pending NotSubmitted

walletStatus

string

Approved Pending NotSubmitted

400

Invalid request parameters

403

Logged-in user is not a Consumer

Updated over 2 years ago

Logs user in and sends one-time passcode (OTP) to the provided email address

Updates details of logged-in consumer

Did this page help you?

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-partner.noba.com/v1/consumers \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 2 years ago

Logs user in and sends one-time passcode (OTP) to the provided email address

Updates details of logged-in consumer

Did this page help you?

Noba Server
Health Check
Checks if the Noba service is up and runningget
Assets
Returns credit card structure metadata for the provided BINget
Returns common api configurationsget
Returns details of a country and its subdivisions supported by Noba Onrampget
Returns a list of all countries supported by Noba Onrampget
Returns a list of all fiat currencies supported by Noba Onrampget
Returns a list of all cryptocurrencies supported by Noba Onrampget
Authentication
Logs user in and sends one-time passcode (OTP) to the provided email addresspost
Submits the one-time passcode (OTP) to retreive an API access tokenpost
Consumer
Gets transaction limit details for logged-in consumerget
Gets all wallet balances for the logged-in consumerget
Submits the one-time passcode (OTP) to confirm wallet add or updatepost
Deletes a saved wallet for the logged-in consumerdelete
Adds a crypto wallet for the logged-in consumerpost
Deletes a payment method for the logged-in consumerdelete
Updates a payment method for logged-in consumerpatch
Adds a payment method for the logged-in consumerpost
Generates a token to connect to Plaid UIget
Sends OTP to user's email to verify update of user profilepost
Adds or updates email address of logged in user with OTPpatch
Sends OTP to user's phone to verify update of user profilepost
Adds or updates phone number of logged in user with OTPpatch
Returns whether the handle is available or not.get
Updates details of logged-in consumerpatch
Gets details of logged-in consumerget
Partner
Adds or updates partner logopost
Gets details of a transactionget
Get all transactions for the given partnerget
Gets all consumers for the partnerget
Adds a new partner adminpost
Gets all admins for the partnerget
Deletes a parter admindelete
Updates details of a partner adminpatch
Gets details of a partner adminget
Updates details of a partnerpatch
Gets details of a partnerget
Transactions
Downloads all the transactions of a particular consumerget
Gets all transactions for the logged-in consumerget
Submits a new transactionpost
Gets details of a transactionget
Checks if the transaction parameters are validget
Get transaction quote (exchange rate, provider fees, network fees etc.)get
Verification
Gets device verification resultget
Retrieves a URL for identity verificationget
Gets result for a previously-submitted document verificationget
Verifies consumer uploaded identification documentspost
Verifies consumer-provided informationpost
Creates a new session for verificationpost
Checks if verification service is upget

Noba Server
Health Check
Checks if the Noba service is up and runningget
Assets
Returns credit card structure metadata for the provided BINget
Returns common api configurationsget
Returns details of a country and its subdivisions supported by Noba Onrampget
Returns a list of all countries supported by Noba Onrampget
Returns a list of all fiat currencies supported by Noba Onrampget
Returns a list of all cryptocurrencies supported by Noba Onrampget
Authentication
Logs user in and sends one-time passcode (OTP) to the provided email addresspost
Submits the one-time passcode (OTP) to retreive an API access tokenpost
Consumer
Gets transaction limit details for logged-in consumerget
Gets all wallet balances for the logged-in consumerget
Submits the one-time passcode (OTP) to confirm wallet add or updatepost
Deletes a saved wallet for the logged-in consumerdelete
Adds a crypto wallet for the logged-in consumerpost
Deletes a payment method for the logged-in consumerdelete
Updates a payment method for logged-in consumerpatch
Adds a payment method for the logged-in consumerpost
Generates a token to connect to Plaid UIget
Sends OTP to user's email to verify update of user profilepost
Adds or updates email address of logged in user with OTPpatch
Sends OTP to user's phone to verify update of user profilepost
Adds or updates phone number of logged in user with OTPpatch
Returns whether the handle is available or not.get
Updates details of logged-in consumerpatch
Gets details of logged-in consumerget
Partner
Adds or updates partner logopost
Gets details of a transactionget
Get all transactions for the given partnerget
Gets all consumers for the partnerget
Adds a new partner adminpost
Gets all admins for the partnerget
Deletes a parter admindelete
Updates details of a partner adminpatch
Gets details of a partner adminget
Updates details of a partnerpatch
Gets details of a partnerget
Transactions
Downloads all the transactions of a particular consumerget
Gets all transactions for the logged-in consumerget
Submits a new transactionpost
Gets details of a transactionget
Checks if the transaction parameters are validget
Get transaction quote (exchange rate, provider fees, network fees etc.)get
Verification
Gets device verification resultget
Retrieves a URL for identity verificationget
Gets result for a previously-submitted document verificationget
Verifies consumer uploaded identification documentspost
Verifies consumer-provided informationpost
Creates a new session for verificationpost
Checks if verification service is upget

Gets details of logged-in consumer

❗️
This endpoint is critical for proper user routing

📘
This endpoint is used for proper front-end parameter population

❗️This endpoint is critical for proper user routing

📘This endpoint is used for proper front-end parameter population

200Details of logged-in consumer

❗️
This endpoint is critical for proper user routing

📘
This endpoint is used for proper front-end parameter population