Refresh a verification - Argyle Docs

curl --request POST \
  --url https://api-sandbox.argyle.com/partners/v2/verifications/refresh \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
  "report": {
    "type": "voie"
  },
  "loan": {
    "number": "1234",
    "borrower_id": "ABC789",
    "application_id": "2121313",
    "officer_email": "john.doe@mortgage.com"
  },
  "billing": {
    "cost_center": "5"
  }
}
'

{
  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
  "client": "39096494-45c8-4fd8-9454-3d1cb2d62db7",
  "created_at": "2023-03-09T16:22:06.081Z",
  "updated_at": "2023-03-09T16:22:06.081Z",
  "channel": "api",
  "status": {
    "state": "PENDING",
    "code": "pending",
    "errors": []
  },
  "report": {
    "id": null,
    "type": "voie",
    "file_url": null,
    "json_url": null
  },
  "employments": [],
  "loan": {
    "number": "1234",
    "borrower_id": "ABC789",
    "application_id": "2121313",
    "officer_email": "john.doe@mortgage.com"
  },
  "billing": {
    "cost_center": "5"
  },
  "data_source": "payroll"
}

POST

/

partners

/

v2

/

verifications

/

refresh

curl --request POST \
  --url https://api-sandbox.argyle.com/partners/v2/verifications/refresh \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
  "report": {
    "type": "voie"
  },
  "loan": {
    "number": "1234",
    "borrower_id": "ABC789",
    "application_id": "2121313",
    "officer_email": "john.doe@mortgage.com"
  },
  "billing": {
    "cost_center": "5"
  }
}
'

{
  "id": "43a2c6c3-1e63-91e5-88e3-f9ab2dcc489b",
  "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
  "client": "39096494-45c8-4fd8-9454-3d1cb2d62db7",
  "created_at": "2023-03-09T16:22:06.081Z",
  "updated_at": "2023-03-09T16:22:06.081Z",
  "channel": "api",
  "status": {
    "state": "PENDING",
    "code": "pending",
    "errors": []
  },
  "report": {
    "id": null,
    "type": "voie",
    "file_url": null,
    "json_url": null
  },
  "employments": [],
  "loan": {
    "number": "1234",
    "borrower_id": "ABC789",
    "application_id": "2121313",
    "officer_email": "john.doe@mortgage.com"
  },
  "billing": {
    "cost_center": "5"
  },
  "data_source": "payroll"
}

Authorizations

Authorization

string

header

required

Username = api_key_id, Password = api_key_secret

Body

application/json

user

string<uuid>

required

User ID for the verification refresh.

report

object

required

Report request configuration for refresh requests.

Show child attributes

loan

object

Optional loan details for regular payroll and mortgage verification workflows.

Show child attributes

billing

object

Optional billing details for regular payroll and mortgage verification workflows.

Show child attributes

Response

200 - application/json

id

string<uuid>

Unique ID of the verification.

user

string<uuid>

ID of the user associated with the verification.

client

string<uuid>

ID of the client on whose behalf the verification was requested.

created_at

string<date-time>

Timestamp (ISO 8601) when the verification was requested.

updated_at

string<date-time>

Timestamp (ISO 8601) when the verification object was last updated.

channel

enum<string>

Origin of the verification order.

Available options:

api,

encompass

Example:

"api"

status

object

Verification status information.

Show child attributes

report

object

Report information.

Show child attributes

employments

object[]

List of employments for the user. Documents only.

Show child attributes

loan

object

Optional loan details for regular payroll and mortgage verification workflows.

Show child attributes

billing

object

Optional billing details for regular payroll and mortgage verification workflows.

Show child attributes

configuration

object

Show child attributes

data_source

enum<string>

Source of verification data.

Available options:

payroll,

banking,

documents