API Endpoints

POST/baas/customer-enrollment

Authorization

bearer

Body

application/json

firstName*string

Example: "Brandon"

lastName*string

Example: "Lewis"

dob*string

Example: "1993-09-19"

phone*Phone (object)

ssn*string

Example: "221-02-9758"

address*all of

Response

201400401404422500

Successful Operation

Body

application/json

statusCode*number

Example: 201

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/customer-enrollment', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": "Brandon",
      "lastName": "Lewis",
      "dob": "1993-09-19",
      "phone": {
        "number": "9786431878",
        "countryCode": "1"
      },
      "ssn": "221-02-9758",
      "address": {
        "street1": "Main Floor",
        "city": "Los Angeles",
        "state": "CA",
        "countryCode": "US",
        "postalCode": "11102"
      }
    }),
});
const data = await response.json();

Response

201400401404422500

{
  "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"
  }
}

POST/baas/customer-complete-enrollment

Authorization

bearer

Response

201401500

Successful Operation

Body

application/json

statusCode*number

Example: 201

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/customer-complete-enrollment', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

201401500

{
  "statusCode": 201,
  "data": {
    "status": "active"
  }
}

GET/baas/customers

Authorization

bearer

Response

200401500

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/customers', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

{
  "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"
  }
}

PUT/baas/customers

Authorization

bearer

Body

application/json

firstName*string

Example: "Brandon"

lastName*string

Example: "Lewis"

dob*string

Example: "1993-09-19"

phone*Phone (object)

ssn*string

Example: "221-02-9758"

address*all of

Response

200401403500

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/customers', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "firstName": "Brandon",
      "lastName": "Lewis",
      "dob": "1993-09-19",
      "phone": {
        "number": "9786431878",
        "countryCode": "1"
      },
      "ssn": "221-02-9758",
      "address": {
        "street1": "Main Floor",
        "city": "Los Angeles",
        "state": "CA",
        "countryCode": "US",
        "postalCode": "11102"
      }
    }),
});
const data = await response.json();

Response

200401403500

{
  "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"
  }
}

GET/baas/compliance-workflows/latest

Authorization

bearer

Response

200401500

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/compliance-workflows/latest', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

{
  "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"
      }
    ]
  }
}

GET/baas/customer-accounts

Authorization

bearer

Response

200401403500

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/customer-accounts', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403500

{
  "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"
      }
    ]
  }
}

GET/baas/customer-accounts/{accountId}

Authorization

bearer

Path parameters

accountId*string

Response

200401403500

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/customer-accounts/{accountId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403500

{
  "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"
  }
}

GET/baas/debit-cards

Authorization

bearer

Response

200401403500

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/debit-cards', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403500

{
  "statusCode": 200,
  "data": {
    "cards": [
      {
        "id": "myCardId",
        "accountId": "074103447228",
        "cardLastFourDigits": "2043",
        "status": "active",
        "image": "myImageCardUrl",
        "type": "virtual",
        "isReadyToUse": true,
        "isLocked": true
      }
    ]
  }
}

POST/baas/debit-cards/physical

Authorization

bearer

Body

application/json

idstring

Example: "myCardId"

accountIdstring

Example: "074103447228"

addressall of

Response

201401403500

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/debit-cards/physical', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201401403500

{
  "statusCode": 201
}

POST/baas/debit-cards/{cardId}/set-pin

Authorization

bearer

Path parameters

cardId*string

Body

application/json

pin*string

Example: "1234"

Response

201401403500

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/debit-cards/{cardId}/set-pin', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "pin": "1234"
    }),
});
const data = await response.json();

Response

201401403500

{
  "statusCode": 201
}

GET/baas/debit-cards/{cardId}/info

Authorization

bearer

Path parameters

cardId*string

Response

200401403500

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/debit-cards/{cardId}/info', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403500

{
  "statusCode": 200,
  "data": {
    "name": "My Debit Card",
    "cardNumber": "4716413853339473",
    "expDate": "2027-01-01",
    "verificationCode": "232",
    "status": "active"
  }
}

PUT/baas/debit-cards/{cardId}/lock

Authorization

bearer

Path parameters

cardId*string

Response

200401403500

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/debit-cards/{cardId}/lock', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403500

{
  "statusCode": 200
}

GET/baas/customer-ach-accounts

Authorization

bearer

Query parameters

Response

200401500

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/customer-ach-accounts?page=0&per_page=0', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

{
  "statusCode": 200
}

POST/baas/transfer-ach

Authorization

bearer

Body

application/json

fromAccountId*string

Example: "999900857817"

amount*string

Example: "24.99"

toAccountIdstring

Example: "myAccountId"

toAccountNumberstring

Example: "86704702"

toRoutingNumberstring

Example: "746978438"

toFirstNamestring

Example: "Trinity"

toLastNamestring

Example: "Dickson"

debitCreditIndicatorenum

Example: "credit"

creditdebit

toAccountTypeenum

Example: "checking"

checkingsavingsmoneyMarket

Response

201401500

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/transfer-ach', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fromAccountId": "999900857817",
      "amount": "24.99"
    }),
});
const data = await response.json();

Response

201401500

{
  "statusCode": 201
}

GET/baas/kyc-documents

Authorization

bearer

Response

200401500

Successful Operation.

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/kyc-documents', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401500

{
  "statusCode": 200,
  "data": {
    "id": "myKycDocumentId",
    "kycStatus": "approved",
    "kycDocuments": [
      {
        "category": 0,
        "options": [
          0
        ],
        "outcome": "approved"
      }
    ]
  }
}

POST/baas/kyc-documents

Authorization

bearer

Body

application/json

id*string

Example: "myId"

document*string

Example: "myDocument"

documentContentTypestring

Example: "myDocumentContentType"

fileNamestring

Example: "myFileName"

notestring

Example: "myNote"

categoryenum

Example: "addressVerification"

idDocumentidDocumentBackaddressVerificationselfiepiiOnboard

optionenum

Example: "license"

passportlicensestateIdutilityBillbankStatementleaseAgreementcurrentPayStubselfieaddressssnphoneNumber

metaall of

Response

201401500

Successful Operation.

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/baas/kyc-documents', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "myId",
      "document": "myDocument"
    }),
});
const data = await response.json();

Response

201401500

{
  "statusCode": 201
}

GET/baas/transactions

Authorization

bearer

Response

200401403500

Successful Operation

Body

application/json

statusCode*number

Example: 200

data*all of

Request

JavaScriptCurlPython

const response = await fetch('/baas/transactions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200401403500

{
  "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"
      }
    ]
  }
}