Skip to main content
GET
https://sandbox.finhub.cloud
/
api
/
v2.1
/
admin
/
person
/
{personId}
/
addresses
Personal Data Management API
curl --request GET \
  --url https://sandbox.finhub.cloud/api/v2.1/admin/person/{personId}/addresses \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Tenant-ID: <x-tenant-id>' \
  --data '
{
  "type": "<string>",
  "street": "<string>",
  "city": "<string>",
  "postalCode": "<string>",
  "country": "<string>",
  "state": "<string>",
  "value": "<string>",
  "primary": true
}
'
{
  "success": true,
  "data": {
    "personId": "person_12345",
    "addresses": [
      {
        "addressId": "addr_001",
        "type": "PRIMARY",
        "street": "123 Main Street",
        "city": "Berlin",
        "postalCode": "10115",
        "country": "DE",
        "verified": true,
        "createdAt": "2024-01-15T10:30:00Z"
      },
      {
        "addressId": "addr_002",
        "type": "MAILING",
        "street": "456 Business Ave",
        "city": "Munich",
        "postalCode": "80331",
        "country": "DE",
        "verified": false,
        "createdAt": "2024-01-20T14:00:00Z"
      }
    ]
  }
}

​
Personal Data Management API

APIs for managing person address and contact information.
Base URL: https://sandbox.finhub.cloud/api/v2.1/admin/person

​
Available Operations

Get Addresses

GET /person/{personId}/addresses

Update Address

PUT /person/{personId}/address

Get Contacts

GET /person/{personId}/contacts

Update Contact

PUT /person/{personId}/contact

​
Get Person Addresses

Retrieves all addresses for a person.

​
Request

​
personId
string
required
Person identifier
​
Authorization
string
required
Bearer token for authentication
​
X-Tenant-ID
string
required
Tenant identifier

​
Code Examples

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/admin/person/person_12345/addresses" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"

{
  "success": true,
  "data": {
    "personId": "person_12345",
    "addresses": [
      {
        "addressId": "addr_001",
        "type": "PRIMARY",
        "street": "123 Main Street",
        "city": "Berlin",
        "postalCode": "10115",
        "country": "DE",
        "verified": true,
        "createdAt": "2024-01-15T10:30:00Z"
      },
      {
        "addressId": "addr_002",
        "type": "MAILING",
        "street": "456 Business Ave",
        "city": "Munich",
        "postalCode": "80331",
        "country": "DE",
        "verified": false,
        "createdAt": "2024-01-20T14:00:00Z"
      }
    ]
  }
}

​
Update Person Address

Updates or adds an address for a person.

​
Request

​
personId
string
required
Person identifier
​
type
string
required
Address type: PRIMARY, MAILING, BUSINESS
​
street
string
required
Street address including number
​
city
string
required
City name
​
postalCode
string
required
Postal/ZIP code
​
country
string
required
Two-letter ISO country code
​
state
string
State or province (if applicable)

​
Code Examples

curl -X PUT "https://sandbox.finhub.cloud/api/v2.1/admin/person/person_12345/address" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "PRIMARY",
    "street": "789 New Street",
    "city": "Frankfurt",
    "postalCode": "60311",
    "country": "DE"
  }'

{
  "success": true,
  "data": {
    "addressId": "addr_001",
    "personId": "person_12345",
    "type": "PRIMARY",
    "street": "789 New Street",
    "city": "Frankfurt",
    "postalCode": "60311",
    "country": "DE",
    "verified": false,
    "updatedAt": "2024-01-15T11:00:00Z"
  }
}

​
Get Person Contacts

Retrieves all contact information for a person.

​
Request

​
personId
string
required
Person identifier

​
Code Examples

curl -X GET "https://sandbox.finhub.cloud/api/v2.1/admin/person/person_12345/contacts" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID"

{
  "success": true,
  "data": {
    "personId": "person_12345",
    "contacts": [
      {
        "contactId": "cont_001",
        "type": "EMAIL",
        "value": "[email protected]",
        "verified": true,
        "primary": true,
        "createdAt": "2024-01-15T10:30:00Z"
      },
      {
        "contactId": "cont_002",
        "type": "PHONE",
        "value": "+49123456789",
        "verified": true,
        "primary": true,
        "createdAt": "2024-01-15T10:30:00Z"
      },
      {
        "contactId": "cont_003",
        "type": "PHONE",
        "value": "+49987654321",
        "verified": false,
        "primary": false,
        "createdAt": "2024-01-20T14:00:00Z"
      }
    ]
  }
}

​
Update Person Contact

Updates or adds contact information for a person.

​
Request

​
personId
string
required
Person identifier
​
type
string
required
Contact type: EMAIL, PHONE, MOBILE
​
value
string
required
Contact value (email address or phone number)
​
primary
boolean
Whether this is the primary contact for this type

​
Code Examples

curl -X PUT "https://sandbox.finhub.cloud/api/v2.1/admin/person/person_12345/contact" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "EMAIL",
    "value": "[email protected]",
    "primary": true
  }'

{
  "success": true,
  "data": {
    "contactId": "cont_001",
    "personId": "person_12345",
    "type": "EMAIL",
    "value": "[email protected]",
    "verified": false,
    "primary": true,
    "updatedAt": "2024-01-15T11:00:00Z"
  }
}

​
Address Types

TypeDescription
PRIMARYPrimary residential address
MAILINGMailing/correspondence address
BUSINESSBusiness address

​
Contact Types

TypeDescription
EMAILEmail address
PHONELandline phone number
MOBILEMobile phone number

​
Response Codes

CodeDescription
200Operation successful
400Invalid request data
401Not Authorized
403Not Allowed
404Person not found
500Internal server error