> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flinks.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Customers
> Use the /api/fdx/5/customers/current endpoint to get information about a particular customer in FDX format.
Use the `/api/fdx/5/customers/current` endpoint to get information about a particular customer in FDX format. This endpoint returns customer profile data only (name, address, phone). Account data is available separately through the [Get Accounts](/api/outbound/endpoints/fdx/get-accounts) endpoint.
To successfully call this endpoint, you must first call the [/Token](/api/outbound/endpoints/authorize/token) endpoint to obtain a valid `access_token` using:
* grant\_type: `authorization_code` or `refresh_token`
* client\_id: `{recipient client_id}`
* client\_secret: `{recipient client_secret}`
* redirect\_uri: `{recipient redirect_uri}`
* code: `{with grant type authorization_code}`
* refresh\_token: `{with grant type refresh_token}`
## How to handle an error response
If you receive an error response, refer to the [List of Data Access Errors](/api/outbound/endpoints/fdx/fdx-errors) for more information about the error and how to resolve it.
Response is different for each Data Provider
This endpoint returns different fields for each Data Provider. For more information about the fields that each Data Provider supports, review the [Data Provider's details](/api/outbound/endpoints/registration/a-data-recipient).
```json 200 - OK theme={null}
{
"customerId": "string",
"name": {
"first": "string",
"middle": "string",
"last": "string",
"suffix": "string",
"prefix": "string",
"company": "string"
},
"dateOfBirth": "string",
"addresses": [
{
"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"country": "string",
"type": "string"
}
],
"telephones": [
{
"type": "string",
"number": "string",
"country": "string"
}
],
}
```
```json 4XX - Result theme={null}
{
"code": 601,
"message": "Customer not found",
"debugMessage": "The provided customer was not found"
}
```
```json 5XX - Result theme={null}
{
"code": 500,
"message": "Internal server error",
"debugMessage": "An unexpected error occured"
}
```
## OpenAPI
````yaml /openapi-outbound.yaml GET /api/fdx/5/customers/current
openapi: 3.0.3
info:
title: Flinks API
description: >
Flinks API provides financial data connectivity, enrichment, and payment
solutions.
## Authentication
Endpoints require authentication using `flinks-auth-key` header (Bearer
token).
For more information, visit: https://docs.flinks.com
version: 3.0.0
contact:
name: Flinks Support
url: https://www.flinks.com/contact/sales
termsOfService: https://www.flinks.com
servers:
- url: https://ob.flinksapp.com
description: Flinks Outbound Production
security:
- BearerAuth: []
tags:
- name: Authorization
description: Endpoints for generating authorization tokens and authenticating requests
paths:
/api/fdx/5/customers/current:
get:
tags:
- FDX
summary: Get Customers
description: >-
Use the /api/fdx/5/customers/current endpoint to get information about a
particular customer in FDX format.
operationId: fdxGetCustomers
responses:
'200':
description: Returned when the customer information is successfully retrieved.
content:
application/json:
schema:
type: object
properties:
customerId:
type: string
description: Unique identifier for the customer.
name:
type: object
description: Customer's name information.
properties:
first:
type: string
description: Customer's first name.
middle:
type: string
description: Customer's middle name.
last:
type: string
description: Customer's last name.
suffix:
type: string
description: Name suffix (e.g., Jr., Sr.).
prefix:
type: string
description: Name prefix (e.g., Mr., Mrs., Dr.).
company:
type: string
description: Company name if applicable.
dateOfBirth:
type: string
description: Customer's date of birth.
email:
type: array
items:
type: string
description: List of customer's email addresses.
addresses:
type: array
description: List of customer's addresses.
items:
type: object
properties:
line1:
type: string
description: First line of the address.
line2:
type: string
description: Second line of the address.
line3:
type: string
description: Third line of the address.
city:
type: string
description: City name.
region:
type: string
description: State or province.
postalCode:
type: string
description: Postal or ZIP code.
country:
type: string
description: Country name or code.
type:
type: string
description: Type of address (e.g., HOME, BUSINESS).
telephones:
type: array
description: List of customer's telephone numbers.
items:
type: object
properties:
type:
type: string
description: Type of telephone (e.g., HOME, MOBILE, WORK).
number:
type: string
description: Phone number.
country:
type: string
description: Country code for the phone number.
accounts:
type: array
description: List of accounts associated with the customer.
items:
type: object
properties:
accountId:
type: string
description: Unique identifier for the account.
links:
type: object
description: Links related to the account.
properties:
href:
type: string
description: URL for the account resource.
action:
type: string
description: Action type for the link.
description:
type: string
description: Description of the link.
relationship:
type: string
description: Customer's relationship to the account.
4XX:
description: >-
Returned when the request contains invalid data or authentication
fails.
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: Error code.
message:
type: string
description: A description of the error.
debugMessage:
type: string
description: >-
Provider custom developer-level error details for
troubleshooting.
5XX:
description: Returned when an internal server error occurred.
content:
application/json:
schema:
type: object
properties:
code:
type: integer
description: Error code.
message:
type: string
description: A description of the error.
debugMessage:
type: string
description: >-
Provider custom developer-level error details for
troubleshooting.
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: Bearer token obtained from the /Token endpoint.
````