Customers

Returns a paged list of all the customers

get

/v1/profiles/{profileId}/customers

Authorizations

Path parameters

partnerIdstringrequired

The id of the partner to retrieve

profileIdstringrequired

The id of the profile

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.bankingservice.ai/v1/profiles/{profileId}/customers'

200

200

{
  "page": 0,
  "pages": 620,
  "size": 20,
  "count": 12383,
  "data": [
    {
      "id": "text",
      "company": "text",
      "first_name": "text",
      "last_name": "text",
      "email": "text",
      "phone": "318000201068",
      "address": {
        "premise": 58,
        "sub_premise": "A",
        "building": "text",
        "postal_code": "text",
        "thoroughfare": "text",
        "locality": "Hoofddorp",
        "state": "Noord-Holland",
        "country": "NL"
      },
      "created": "2024-09-25T12:01:00.103Z"
    }
  ]
}

OK

Creates a customer

post

/v1/profiles/{profileId}/customers

Authorizations

Path parameters

profileIdstringrequired

The id of the profile

Body

companystring

Company name

first_namestring

First name of the customer

Example: John

last_namestring

Last name of the customer

Example: Doe

emailstring

Email adderss of the customer

Example: [e-mail]

phonestring

Example: 318000201068

addressobject

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.bankingservice.ai/v1/profiles/{profileId}/customers' \
  --header 'Content-Type: application/json' \
  --data '{
    "company": "text",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[e-mail]",
    "phone": "318000201068",
    "address": {
      "premise": 58,
      "sub_premise": "A",
      "building": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "Hoofddorp",
      "state": "Noord-Holland",
      "country": "NL"
    }
  }'

200

400

200

{
  "id": "text",
  "company": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "phone": "318000201068",
  "address": {
    "premise": 58,
    "sub_premise": "A",
    "building": "text",
    "postal_code": "text",
    "thoroughfare": "text",
    "locality": "Hoofddorp",
    "state": "Noord-Holland",
    "country": "NL"
  },
  "created": "2024-09-25T12:01:00.103Z"
}

OK

Returns the data of the customer

get

/v1/profiles/{profileId}/customers/{customerId}

Authorizations

Path parameters

profileIdstringrequired

The id of the profile

customerIdstringrequired

The id of the customer

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.bankingservice.ai/v1/profiles/{profileId}/customers/{customerId}'

200

404

200

{
  "id": "text",
  "company": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "phone": "318000201068",
  "address": {
    "premise": 58,
    "sub_premise": "A",
    "building": "text",
    "postal_code": "text",
    "thoroughfare": "text",
    "locality": "Hoofddorp",
    "state": "Noord-Holland",
    "country": "NL"
  },
  "created": "2024-09-25T12:01:00.103Z"
}

OK

Updates a customer

put

/v1/profiles/{profileId}/customers/{customerId}

Authorizations

Path parameters

profileIdstringrequired

The id of the profile

customerIdstringrequired

The id of the customer

Body

companystring

Company name

first_namestring

First name of the customer

Example: John

last_namestring

Last name of the customer

Example: Doe

emailstring

Email adderss of the customer

Example: [e-mail]

phonestring

Example: 318000201068

addressobject

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.bankingservice.ai/v1/profiles/{profileId}/customers/{customerId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "company": "text",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[e-mail]",
    "phone": "318000201068",
    "address": {
      "premise": 58,
      "sub_premise": "A",
      "building": "text",
      "postal_code": "text",
      "thoroughfare": "text",
      "locality": "Hoofddorp",
      "state": "Noord-Holland",
      "country": "NL"
    }
  }'

200

400

200

{
  "id": "text",
  "company": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "phone": "318000201068",
  "address": {
    "premise": 58,
    "sub_premise": "A",
    "building": "text",
    "postal_code": "text",
    "thoroughfare": "text",
    "locality": "Hoofddorp",
    "state": "Noord-Holland",
    "country": "NL"
  },
  "created": "2024-09-25T12:01:00.103Z"
}

OK

Deletes the customer

delete

/v1/profiles/{profileId}/customers/{customerId}

Authorizations

Path parameters

profileIdstringrequired

The id of the profile

customerIdstringrequired

The id of the customer

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.bankingservice.ai/v1/profiles/{profileId}/customers/{customerId}'

200

400

200

{
  "id": "text",
  "company": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "phone": "318000201068",
  "address": {
    "premise": 58,
    "sub_premise": "A",
    "building": "text",
    "postal_code": "text",
    "thoroughfare": "text",
    "locality": "Hoofddorp",
    "state": "Noord-Holland",
    "country": "NL"
  },
  "created": "2024-09-25T12:01:00.103Z"
}

OK