POST
/
getByOrganizationId
/
{organizationId}
curl --request POST \
  --url https://gateway.finhub.cloud/customer/getByOrganizationId/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'tenantId: <tenantid>' \
  --data '{
  "type": "<string>",
  "created": "<string>",
  "status": "<string>",
  "pageNumber": 123,
  "pageSize": 123
}'
{
  "customers": [
    {
      "id": "<string>",
      "customerType": "Person",
      "customerName": "<string>",
      "customerStatus": "new",
      "categorization": "category1",
      "notifications": [
        {
          "notificationType": "Marketingemails",
          "isEnabled": true
        }
      ],
      "person": {
        "firstName": {
          "name": "<string>",
          "order": 123,
          "abbreviation": "<string>",
          "language": "<string>",
          "native": "<string>",
          "suffix": "<string>",
          "prefix": "<string>"
        },
        "lastName": {
          "name": "<string>",
          "order": 123,
          "abbreviation": "<string>",
          "language": "<string>",
          "native": "<string>",
          "suffix": "<string>",
          "prefix": "<string>"
        },
        "fullName": "<string>",
        "groupId": "<string>",
        "gender": "Male",
        "dateOfBirth": "<string>",
        "placeOfBirth": "<string>",
        "nationality": "<string>",
        "pinCode": "<string>",
        "password": "<string>",
        "email": "<string>",
        "telephoneNumbers": [
          {
            "phoneType": "fixed",
            "operator": "<string>",
            "encoding": "numbers",
            "country": "<string>",
            "number": "<string>",
            "purpose": "<string>"
          }
        ],
        "addresses": [
          {
            "addressPurpose": "<string>",
            "address": {
              "country": "<string>",
              "area": "<string>",
              "zipCode": "<string>",
              "city": "<string>",
              "street": "<string>",
              "streetNumber": [
                "<string>"
              ],
              "building": "<string>",
              "apartment": "<string>",
              "entrance": "<string>",
              "floor": "<string>",
              "doorNumber": "<string>",
              "geoPosition": {
                "latitude": 123,
                "longitude": 123,
                "altitude": 123
              },
              "alternative": {
                "word1": "<string>",
                "word2": "<string>",
                "word3": "<string>"
              },
              "relatedToAddress": [
                {
                  "relationType": "near_by",
                  "address": "<string>"
                }
              ],
              "additionalData": [
                {
                  "name": "<string>",
                  "type": "Number",
                  "value": "<string>"
                }
              ]
            }
          }
        ],
        "documents": [
          {
            "purpose": "KYB",
            "name": "<string>",
            "documentType": "ID front side",
            "location": "<string>",
            "verificationResponse": "<string>",
            "status": "underverification",
            "metadata": [
              {
                "name": "<string>",
                "type": "Number",
                "value": "<string>"
              }
            ]
          }
        ],
        "SecretQuestion": [
          {
            "question": "<string>",
            "answer": "<string>"
          }
        ]
      },
      "twofa": {
        "targetType": "SMS",
        "targetValue": "<string>",
        "targetCode": "<string>",
        "inputCode": "<string>",
        "codematch": true
      }
    }
  ],
  "pagination": {
    "numberOfPage": 123,
    "totalSize": 123,
    "currentPage": 123
  }
}

Authorizations

Authorization
string
headerrequired

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

tenantId
string
required

Tenant/Owner id

Path Parameters

organizationId
string
required

Body

application/json
type
string
created
string
status
string
pageNumber
integer
pageSize
integer

Response

200 - application/json
customers
object[]
pagination
object