Skip to main content
GET
/
api
/
subjects
/
{client_subject_id}
Retrieve a specific subject
curl --request GET \
  --url http://localhost/api/api/subjects/{client_subject_id} \
  --header 'Authorization: Bearer <token>'
{
  "client_subject_id": "<string>",
  "subject_name": "<string>",
  "unique_identification_number": "<string>",
  "account_holder": true,
  "address": "<string>",
  "customer_segment": "<string>",
  "date_and_place_of_birth": "<string>",
  "country_of_birth_or_incorporation": "<string>",
  "nationality": "<string>",
  "account_type": "<string>",
  "account_type_ii": "<string>",
  "account_opening_date": "<string>",
  "account_opening_date_ii": "<string>",
  "customer_aml_risk_rating": "<string>",
  "customer_account": "<string>",
  "customer_account_ii": "<string>",
  "customer_opening_date": "<string>",
  "source_of_funds": "<string>",
  "average_monthly_income": "<string>",
  "cif_status": "<string>",
  "occupation": "<string>",
  "industry": "<string>",
  "purpose_of_account": "<string>",
  "contact_number": "<string>",
  "email_address": "<string>",
  "risk_assessment_score": "<string>",
  "created_by": 123,
  "modified_by": 123
}
Customer (used in this doc) and Subject (used in the API/backend) mean the same thing: one individual.
This is to retrieve one individual customer by their client_subject_id If a customer with the given client subject ID is not found, the following response will be provided. 
Expected Response Code: 404
Response Body: JSON Object
e.g

{
	"detail": "Not found."
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Path Parameters

​
client_subject_id
string
required

Client subject ID.

Response

200 - application/json

Subject retrieved successfully.

​
client_subject_id
string
required
Maximum string length: 255
​
subject_name
string
required
Maximum string length: 255
​
unique_identification_number
string
Maximum string length: 255
​
account_holder
boolean | null
​
address
string
Maximum string length: 255
​
customer_segment
string
Maximum string length: 255
​
date_and_place_of_birth
string
Maximum string length: 255
​
country_of_birth_or_incorporation
string
Maximum string length: 255
​
nationality
string
Maximum string length: 60
​
account_type
string
Maximum string length: 255
​
account_type_ii
string
Maximum string length: 255
​
account_opening_date
string
Maximum string length: 255
​
account_opening_date_ii
string
Maximum string length: 255
​
customer_aml_risk_rating
string
Maximum string length: 255
​
customer_account
string
Maximum string length: 255
​
customer_account_ii
string
Maximum string length: 255
​
customer_opening_date
string
Maximum string length: 255
​
source_of_funds
string
Maximum string length: 255
​
average_monthly_income
string
Maximum string length: 255
​
cif_status
string
Maximum string length: 255
​
occupation
string
Maximum string length: 255
​
industry
string
Maximum string length: 255
​
purpose_of_account
string
Maximum string length: 255
​
contact_number
string
Maximum string length: 255
​
email_address
string
Maximum string length: 255
​
risk_assessment_score
string<decimal>
Pattern: ^-?\d{0,3}(?:\.\d{0,2})?$
​
created_by
integer | null
​
modified_by
integer | null