Customers

get

Returns a paged list of all the customers

Authorizations

oAuth2

Path parameters

partnerIdstringRequired

The id of the partner to retrieve

profileIdstringRequired

The id of the profile

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/profiles/{profileId}/customers HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

OK

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

post

Creates a customer

Authorizations

oAuth2

Path parameters

profileIdstringRequired

The id of the profile

Body

application/json

PSU creation customer type

companystringOptional

Company name

first_namestringOptional

First name of the customer

Example: John

last_namestringOptional

Last name of the customer

Example: Doe

emailstringOptional

Email adderss of the customer

Example: [email protected]

phonestringOptionalExample: 318000201068

Responses

200

OK

application/json

400

Invalid request

application/json

post

HTTPcURLJavaScriptPython

POST /v1/profiles/{profileId}/customers HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 274

{
  "company": "text",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone": "318000201068",
  "address": {
    "premise": 58,
    "sub_premise": "A",
    "building": "text",
    "postal_code": "text",
    "thoroughfare": "text",
    "locality": "Hoofddorp",
    "state": "Noord-Holland",
    "country": "NL"
  }
}

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

get

Returns the data of the customer

Authorizations

oAuth2

Path parameters

profileIdstringRequired

The id of the profile

customerIdstringRequired

The id of the customer

Responses

200

OK

application/json

404

Resource not found

application/json

get

HTTPcURLJavaScriptPython

GET /v1/profiles/{profileId}/customers/{customerId} HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

put

Updates a customer

Authorizations

oAuth2

Path parameters

profileIdstringRequired

The id of the profile

customerIdstringRequired

The id of the customer

Body

application/json

PSU creation customer type

companystringOptional

Company name

first_namestringOptional

First name of the customer

Example: John

last_namestringOptional

Last name of the customer

Example: Doe

emailstringOptional

Email adderss of the customer

Example: [email protected]

phonestringOptionalExample: 318000201068

Responses

200

OK

application/json

400

Invalid request

application/json

put

HTTPcURLJavaScriptPython

PUT /v1/profiles/{profileId}/customers/{customerId} HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 274

{
  "company": "text",
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "phone": "318000201068",
  "address": {
    "premise": 58,
    "sub_premise": "A",
    "building": "text",
    "postal_code": "text",
    "thoroughfare": "text",
    "locality": "Hoofddorp",
    "state": "Noord-Holland",
    "country": "NL"
  }
}

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

delete

Deletes the customer

Authorizations

oAuth2

Path parameters

profileIdstringRequired

The id of the profile

customerIdstringRequired

The id of the customer

Responses

200

OK

application/json

400

Invalid request

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/profiles/{profileId}/customers/{customerId} HTTP/1.1
Host: api.bankingservice.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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