API Endpoints

PreviousResources NextAggregators

Last updated 2 years ago

Was this helpful?

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/baas/customers' \
  --header 'Authorization: Bearer JWT'

200

401

500

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

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/baas/compliance-workflows/latest' \
  --header 'Authorization: Bearer JWT'

200

401

500

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

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/baas/customer-accounts' \
  --header 'Authorization: Bearer JWT'

200

401

403

500

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

get

Authorizations

Path parameters

accountIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/baas/customer-accounts/{accountId}' \
  --header 'Authorization: Bearer JWT'

200

401

403

500

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

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/baas/debit-cards' \
  --header 'Authorization: Bearer JWT'

200

401

403

500

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

Successful Operation

get

Authorizations

Path parameters

cardIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/baas/debit-cards/{cardId}/info' \
  --header 'Authorization: Bearer JWT'

200

401

403

500

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

Successful Operation

put

Authorizations

Path parameters

cardIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/baas/debit-cards/{cardId}/lock' \
  --header 'Authorization: Bearer JWT'

200

401

403

500

{
  "statusCode": 200
}

Successful Operation.

get

Authorizations

Query parameters

pagenumberrequired

per_pagenumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/baas/customer-ach-accounts?page=1&per_page=1' \
  --header 'Authorization: Bearer JWT'

200

401

500

{
  "statusCode": 200
}

Successful Operation.

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/baas/kyc-documents' \
  --header 'Authorization: Bearer JWT'

200

401

500

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

Successful Operation.

get

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/baas/transactions' \
  --header 'Authorization: Bearer JWT'

200

401

403

500

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

Successful Operation

post

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/baas/customer-complete-enrollment' \
  --header 'Authorization: Bearer JWT'

201

401

500

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

Successful Operation

post

Authorizations

Body

firstNamestringrequiredExample: Brandon

lastNamestringrequiredExample: Lewis

dobstringrequiredExample: 1993-09-19

phoneobjectrequired

ssnstringrequiredExample: 221-02-9758

addressall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/baas/customer-enrollment' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

201

400

401

404

422

500

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

put

Authorizations

Body

firstNamestringrequiredExample: Brandon

lastNamestringrequiredExample: Lewis

dobstringrequiredExample: 1993-09-19

phoneobjectrequired

ssnstringrequiredExample: 221-02-9758

addressall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/baas/customers' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

200

401

403

500

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

post

Authorizations

Body

idstringoptionalExample: myCardId

accountIdstringoptionalExample: 074103447228

addressall ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/baas/debit-cards/physical' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "myCardId",
    "accountId": "074103447228",
    "address": {
      "street1": "Main Floor",
      "street2": "Secondary St",
      "city": "Los Angeles",
      "state": "CA",
      "countryCode": "US",
      "postalCode": "11102"
    }
  }'

201

401

403

500

{
  "statusCode": 201
}

Successful Operation.

post

Authorizations

Path parameters

cardIdstringrequired

Body

pinstringrequiredExample: 1234

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/baas/debit-cards/{cardId}/set-pin' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "pin": "1234"
  }'

201

401

403

500

{
  "statusCode": 201
}

Successful Operation.

post

Authorizations

Body

fromAccountIdstringrequiredExample: 999900857817

amountstringrequiredExample: 24.99

toAccountIdstringoptionalExample: myAccountId

toAccountNumberstringoptionalExample: 86704702

toRoutingNumberstringoptionalExample: 746978438

toFirstNamestringoptionalExample: Trinity

toLastNamestringoptionalExample: Dickson

debitCreditIndicatorstring · enumoptionalExample: creditAvailable options:

toAccountTypestring · enumoptionalExample: checkingAvailable options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/baas/transfer-ach' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "fromAccountId": "999900857817",
    "amount": "24.99",
    "toAccountId": "myAccountId",
    "toAccountNumber": "86704702",
    "toRoutingNumber": "746978438",
    "toFirstName": "Trinity",
    "toLastName": "Dickson",
    "debitCreditIndicator": "credit",
    "toAccountType": "checking"
  }'

201

401

500

{
  "statusCode": 201
}

Successful Operation.

post

Authorizations

Body

idstringrequiredExample: myId

documentstringrequiredExample: myDocument

documentContentTypestringoptionalExample: myDocumentContentType

fileNamestringoptionalExample: myFileName

notestringoptionalExample: myNote

categorystring · enumoptionalExample: addressVerificationAvailable options:

optionstring · enumoptionalExample: licenseAvailable options:

metaall ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/baas/kyc-documents' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "myId",
    "document": "myDocument",
    "documentContentType": "myDocumentContentType",
    "fileName": "myFileName",
    "note": "myNote",
    "category": "addressVerification",
    "option": "license",
    "meta": {
      "countryCode": "1",
      "stateCode": "510"
    }
  }'

201

401

500

{
  "statusCode": 201
}

Successful Operation.

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes