cURL
curl --request POST \
--url https://public.api.live.turrisfi.com/v1/agents \
--header 'Content-Type: application/json' \
--data '
{
"npn": "12345678",
"middleName": "Quentin",
"email": "example@test.com",
"downstreamEntityAssociationId": "507f1f77bcf86cd799439012"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
npn: '12345678',
middleName: 'Quentin',
email: 'example@test.com',
downstreamEntityAssociationId: '507f1f77bcf86cd799439012'
})
};
fetch('https://public.api.live.turrisfi.com/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://public.api.live.turrisfi.com/v1/agents"
payload = {
"npn": "12345678",
"middleName": "Quentin",
"email": "example@test.com",
"downstreamEntityAssociationId": "507f1f77bcf86cd799439012"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"agent": {
"_id": "<string>",
"npn": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"downstreamEntityAgentAssociationIds": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"middleName": "<string>"
},
"creationPath": "addition",
"niprDataSubscription": {
"dataOwnerId": "<string>",
"dataOwnerModel": "<string>",
"entityModel": "<string>",
"entityInfo": {
"status": "<string>",
"jobId": "<string>",
"message": "<string>",
"rawEntityInfoId": "<string>"
},
"npn": "<string>",
"lastSynchronizationDate": "2023-11-07T05:31:56Z",
"pdbAlertsSubscriptionStatus": "<string>",
"pdbAlertsPausedAt": "2023-11-07T05:31:56Z"
},
"isUploadedByUpstreamEntity": true,
"isDeleted": true,
"isArchived": true,
"authority": [
{
"upstreamEntityProductId": "<string>",
"requestedStates": [
"CA",
"TX",
"NY"
],
"approvedStates": [
"CA",
"TX"
]
}
],
"email": "<string>",
"isDeliverable": true,
"externalId": "<string>"
},
"requestId": "dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8",
"timestamp": "2025-11-12T20:49:03.293Z"
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}Agents
Create Agent
Add a new agent to your organization
POST
/
v1
/
agents
cURL
curl --request POST \
--url https://public.api.live.turrisfi.com/v1/agents \
--header 'Content-Type: application/json' \
--data '
{
"npn": "12345678",
"middleName": "Quentin",
"email": "example@test.com",
"downstreamEntityAssociationId": "507f1f77bcf86cd799439012"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
npn: '12345678',
middleName: 'Quentin',
email: 'example@test.com',
downstreamEntityAssociationId: '507f1f77bcf86cd799439012'
})
};
fetch('https://public.api.live.turrisfi.com/v1/agents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://public.api.live.turrisfi.com/v1/agents"
payload = {
"npn": "12345678",
"middleName": "Quentin",
"email": "example@test.com",
"downstreamEntityAssociationId": "507f1f77bcf86cd799439012"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"data": {
"agent": {
"_id": "<string>",
"npn": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"downstreamEntityAgentAssociationIds": [
"<string>"
],
"createdAt": "<string>",
"updatedAt": "<string>",
"middleName": "<string>"
},
"creationPath": "addition",
"niprDataSubscription": {
"dataOwnerId": "<string>",
"dataOwnerModel": "<string>",
"entityModel": "<string>",
"entityInfo": {
"status": "<string>",
"jobId": "<string>",
"message": "<string>",
"rawEntityInfoId": "<string>"
},
"npn": "<string>",
"lastSynchronizationDate": "2023-11-07T05:31:56Z",
"pdbAlertsSubscriptionStatus": "<string>",
"pdbAlertsPausedAt": "2023-11-07T05:31:56Z"
},
"isUploadedByUpstreamEntity": true,
"isDeleted": true,
"isArchived": true,
"authority": [
{
"upstreamEntityProductId": "<string>",
"requestedStates": [
"CA",
"TX",
"NY"
],
"approvedStates": [
"CA",
"TX"
]
}
],
"email": "<string>",
"isDeliverable": true,
"externalId": "<string>"
},
"requestId": "dev-2c5e7cf2-9acf-4c8c-ab2f-b81f39d775a8",
"timestamp": "2025-11-12T20:49:03.293Z"
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}{
"statusCode": 123,
"requestId": "<string>",
"errorType": "validation_error",
"errorMessage": [
"<string>"
],
"timestamp": "<string>",
"details": {}
}Creates a new agent associated with a downstream entity. The agent is identified by their National Producer Number (NPN).
Body
application/json
National Producer Number (NPN) of the agent
Example:
"12345678"
Middle name of the agent (optional). Auto-populated from NIPR if absent.
Maximum string length:
100Example:
"Quentin"
Email address of the agent
Example:
"example@test.com"
MongoDB ID of the downstream entity association
Example:
"507f1f77bcf86cd799439012"
Was this page helpful?