Path parameters

• externalAgentId string(uuid) Required

  The id of the external agent.

Responses

• 200 application/json

  Request succeeded.

  Hide response attributes Show response attributes object

  • id string(uuid)

    The unique id.

  • createdTimestamp string(date-time) | null

    The date and time of creation in UTC time.

  • modifiedTimestamp string(date-time) | null

    The date and time last modification in UTC time.

  • endCode string Required

    The code end or side of the transaction.

    Values are B or S.

  • typeCode string Required

    The code for the type of external agent this is. This will be either "B" for outside broker or "R" for referral.

    Values are B or R.

  • paymentMethodCode string | null

    The code for the method use to pay the external agent.

    Values are B, N, or E.

  • firstName string Required

    The first name of the external agent.

  • lastName string Required

    The last name of the external agent.

  • companyName string | null

    The name of the company for which the external agent works.

  • addressLine1 string | null

    The street address.

  • addressLine2 string | null

    The address unit number.

  • addressCity string | null

    The city of the address.

  • addressPostalCode string | null

    The postal code of the address. This will be unformatted.

  • addressProvinceCode string | null

    The two character state or province code.

  • addressCountryCode string | null

    The two character country code.

  • phoneNumberMain string | null

    The external agent's main phone number.

  • phoneNumberBusiness string | null

    The external agent's business phone number.

  • faxNumberMain string | null

    The external agent's main fax number.

  • emailAddressMain string | null

    The external agent's main email address.

  • emailAddressBusiness string | null

    The external agent's business email address.

• 400 application/json

  Invalid request. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 401 application/json

  Unauthorized. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 403 application/json

  Permission denied. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 404 application/json

  Not found. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 422 application/json

  Validation failed. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.