API Endpoints
BrandonLewis1993-09-19221-02-9758Successful Operation
Error processing the information
Failed because the authentication token is not sent or it has already expired.
Error processing The information
Error processing the information
Error processing the information
POST /baas/customer-enrollment HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 265
{
"firstName": "Brandon",
"lastName": "Lewis",
"dob": "1993-09-19",
"phone": {
"number": "9786431878",
"countryCode": "1"
},
"ssn": "221-02-9758",
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
}
}{
"statusCode": 201,
"data": {
"firstName": "Brandon",
"lastName": "Lewis",
"dob": "1993-09-19",
"phone": {
"number": "9786431878",
"countryCode": "1"
},
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
},
"status": "active",
"kycStatus": "approved",
"userExternalId": "c08b9baf-4791-42e1-8d10-94bbbcdee1f9"
}
}Successful Operation
Failed because the authentication token is not sent or it has already expired.
Error processing the information
POST /baas/customer-complete-enrollment HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 201,
"data": {
"status": "active"
}
}Successful Operation
Failed because the authentication token is not sent or it has already expired.
Error processing the information
GET /baas/customers HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"firstName": "Brandon",
"lastName": "Lewis",
"dob": "1993-09-19",
"phone": {
"number": "9786431878",
"countryCode": "1"
},
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
},
"status": "active",
"kycStatus": "approved",
"userExternalId": "c08b9baf-4791-42e1-8d10-94bbbcdee1f9"
}
}BrandonLewis1993-09-19221-02-9758Successful Operation
Failed because the authentication token is not sent or it has already expired.
Customer has not been created
Error processing the information
PUT /baas/customers HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 265
{
"firstName": "Brandon",
"lastName": "Lewis",
"dob": "1993-09-19",
"phone": {
"number": "9786431878",
"countryCode": "1"
},
"ssn": "221-02-9758",
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
}
}{
"statusCode": 200,
"data": {
"firstName": "Brandon",
"lastName": "Lewis",
"dob": "1993-09-19",
"phone": {
"number": "9786431878",
"countryCode": "1"
},
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
},
"status": "active",
"kycStatus": "approved",
"userExternalId": "c08b9baf-4791-42e1-8d10-94bbbcdee1f9"
}
}Successful Operation
Failed because the authentication token is not sent or it has already expired.
Error processing the information
GET /baas/compliance-workflows/latest HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"id": "myId",
"acceptedDocuments": [
{
"id": "myDocumentId",
"name": "Terms and Conditions",
"complianceDocumentUrl": "myDocumentUrl",
"electronicSignatureRequired": "Brandon Lewis"
}
],
"currentStepDocumentsPending": [
{
"id": "myDocumentId",
"name": "Terms and Conditions",
"complianceDocumentUrl": "myDocumentUrl",
"electronicSignatureRequired": "Brandon Lewis"
}
],
"allDocuments": [
{
"id": "myDocumentId",
"name": "Terms and Conditions",
"complianceDocumentUrl": "myDocumentUrl",
"electronicSignatureRequired": "Brandon Lewis"
}
]
}
}Successful Operation
Failed because the authentication token is not sent or it has already expired.
Customer has not been created
Error processing the information
GET /baas/customer-accounts HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"accounts": [
{
"id": "myAccountId",
"status": "active",
"availableBalance": "100",
"balance": "100",
"pendingBalance": "15",
"accountNumber": "83534957",
"routingNumber": "977962271",
"category": "primary",
"type": "savings",
"currencyCode": "USD",
"name": "Bank Of America"
}
]
}
}Successful Operation
Failed because the authentication token is not sent or it has already expired.
Customer has not been created
Error processing the information
GET /baas/customer-accounts/{accountId} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"id": "myAccountId",
"status": "active",
"availableBalance": "100",
"balance": "100",
"pendingBalance": "15",
"accountNumber": "83534957",
"routingNumber": "977962271",
"category": "primary",
"type": "savings",
"currencyCode": "USD",
"name": "Bank Of America"
}
}Successful Operation
Failed because the authentication token is not sent or it has already expired.
Customer has not been created
Error processing the information
GET /baas/debit-cards HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"cards": [
{
"id": "myCardId",
"accountId": "074103447228",
"cardLastFourDigits": "2043",
"status": "active",
"image": "myImageCardUrl",
"type": "virtual",
"isReadyToUse": true,
"isLocked": true
}
]
}
}myCardId074103447228Successful Operation.
{"statusCode":201}Failed because the authentication token is not sent or it has already expired.
Customer has not been created
Error processing the information
POST /baas/debit-cards/physical HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 178
{
"id": "myCardId",
"accountId": "074103447228",
"address": {
"street1": "Main Floor",
"street2": "Secondary St",
"city": "Los Angeles",
"state": "CA",
"countryCode": "US",
"postalCode": "11102"
}
}{
"statusCode": 201
}1234Successful Operation.
{"statusCode":201}Failed because the authentication token is not sent or it has already expired.
Customer has not been created
Error processing the information
POST /baas/debit-cards/{cardId}/set-pin HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"pin": "1234"
}{
"statusCode": 201
}Successful Operation
Failed because the authentication token is not sent or it has already expired.
Customer has not been created
Error processing the information
GET /baas/debit-cards/{cardId}/info HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"name": "My Debit Card",
"cardNumber": "4716413853339473",
"expDate": "2027-01-01",
"verificationCode": "232",
"status": "active"
}
}Successful Operation.
{"statusCode":200}Failed because the authentication token is not sent or it has already expired.
Customer has not been created
Error processing the information
PUT /baas/debit-cards/{cardId}/lock HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}Successful Operation.
{"statusCode":200}Failed because the authentication token is not sent or it has already expired.
Error processing the information
GET /baas/customer-ach-accounts?page=1&per_page=1 HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200
}99990085781724.99myAccountId86704702746978438TrinityDicksoncreditPossible values: checkingPossible values: Successful Operation.
{"statusCode":201}Failed because the authentication token is not sent or it has already expired.
Error processing the information
POST /baas/transfer-ach HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 242
{
"fromAccountId": "999900857817",
"amount": "24.99",
"toAccountId": "myAccountId",
"toAccountNumber": "86704702",
"toRoutingNumber": "746978438",
"toFirstName": "Trinity",
"toLastName": "Dickson",
"debitCreditIndicator": "credit",
"toAccountType": "checking"
}{
"statusCode": 201
}Successful Operation.
Failed because the authentication token is not sent or it has already expired.
Error processing the information
GET /baas/kyc-documents HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"id": "myKycDocumentId",
"kycStatus": "approved",
"kycDocuments": [
{
"category": 1,
"options": [
1
],
"outcome": "approved"
}
]
}
}myIdmyDocumentmyDocumentContentTypemyFileNamemyNoteaddressVerificationPossible values: licensePossible values: Successful Operation.
{"statusCode":201}Failed because the authentication token is not sent or it has already expired.
Error processing the information
POST /baas/kyc-documents HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 220
{
"id": "myId",
"document": "myDocument",
"documentContentType": "myDocumentContentType",
"fileName": "myFileName",
"note": "myNote",
"category": "addressVerification",
"option": "license",
"meta": {
"countryCode": "1",
"stateCode": "510"
}
}{
"statusCode": 201
}Successful Operation
Failed because the authentication token is not sent or it has already expired.
Customer has not been created
Error processing the information
GET /baas/transactions HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"statusCode": 200,
"data": {
"totalCount": 1,
"count": 1,
"limit": 1,
"offset": 1,
"transactions": [
{
"id": "myTransactionId",
"amount": "100",
"description": "Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"createdAt": "2019-10-01 14:56:50",
"currencyCode": "USD",
"type": "myTransactionType",
"status": "myStatus",
"direction": "credit"
}
]
}
}Last updated
Was this helpful?