HomeAPI Reference
API Reference

Creates a new party with the provided details. Returns the created party including the auto-generated ID.

post
https://api.recvue.com/api/v2.0/parties

Creates a new party record in the system. Provide the party configuration including party details, attributes, roles, and relationship information. Returns the ID of the created record in the response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Party request object containing all party details, attributes, roles, and relationship information to create a new party record.

Party details representing an individual or organization

string

The first line of address

string

The second line of address

date-time

The custom date attribute 1

number

The custom numeric attribute 1

string

The custom varchar attribute 1

date-time

The custom date attribute 2

number

The custom numeric attribute 2

string

The custom varchar attribute 2

date-time

The custom date attribute 3

number

The custom numeric attribute 3

string

The custom varchar attribute 3

date-time

The custom date attribute 4

number

The custom numeric attribute 4

string

The custom varchar attribute 4

date-time

The custom date attribute 5

number

The custom numeric attribute 5

string

The custom varchar attribute 5

string

The context for custom attributes

string

Name of the city where the party is located or registered

string

Name of the primary contact person for this party

string

Name of the secondary or alternate contact person for this party

string

The country name where the party is located or legally registered for business operations

string

The county name representing the local administrative division within the state or province where the party resides

string

The external reference identifier for integration with other systems

number

The unique identifier for the party record

string
required

The name of the party

string
required

The unique party number identifier

string

The type of party (e.g., PERSON, ORGANIZATION)

string

The personal identification number or tax ID

string

The state or province name

Headers
string
required
Responses

Updated 3 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago