Log In

Retrieve the status of an external contact


This endpoint will allow you to check the status of your external Contact using their borderless™ external contact @handle. When a Contact is first added the account will be PENDING. Once a payment to the Contact has been submitted the Contact will undergo compliance review. If approved, the Contact status will be VERIFIED

Data Requirements

Provide the following data requirements when sending a GET request to the Retrieve Status endpoint.

Additional Header parameter:

Parameter Required? Description Type
Client-Id No Unique identifier of Child Account (required only for Partner). See Authentication Page to learn more. String

The body of the request should contain the following property:

Parameter Required? Description Type
handle Yes This is the @handle associated with a contact's account. For an internal contact it appears as @{handle}, for an external contact the format is ^{XXXXX} where X represents randomly generated alphanumeric strings. An example would be ^be39D. String

Note: The "Try it!" feature located on the right below the code box, does not support GET requests that contain a body. To test out this GET endpoint, please use a third-party application such as Postman.

Click Try It! to start a request and see the response here!